Getting ready for 1.4.0 RC1
[squirrelmail.git] / help / en_US / options.hlp
1 <chapter>
2 <title>
3 Options
4 </title>
5 <summary>
6 You can customize the way that SquirrelMail looks and responds to you
7 by setting different options in this section.
8 </summary>
9 <description>
10 <p>
11 One of the great things about SquirrelMail is the degree to which it may be customized.
12 Depending on the configuration, you may have several choices of themes, languages,
13 folders, and other preferences. All of these may be changed without affecting any other
14 users on the system. There are at least five main parts to the Options:
15 Personal, Display, Message Highlighting, Folders and Index Order.
16 More parts may be available depending on your SquirrelMail installation.
17 </p>
18 </description>
19 </chapter>
21 <section>
22 <title>
23 Personal Information
24 </title>
25 <description>
26 <b>Full Name</b><br>
27 You should put your entire name here. For example, "John Doe". This is what is
28 shown to people that you send the message to. They will see that it is from
29 "John Doe". If you don't fill this in, they will see it is from your email address,
30 "".
31 <br><br>
33 <b>E-Mail Address</b><br>
34 <i>Optional</i> - If your email address is different than what is automatically
35 assigned, you can change it here.
36 <br><br>
38 <b>Reply To</b><br>
39 <i>Optional</i> - This is the email address that people will reply to when they
40 reply to your message. If this is different than the email address you are sending
41 from, you can enter it here. This is useful if you want people to reply to your
42 Yahoo account rather than your office address.
43 <br><br>
45 <b>Multiple Identities</b><BR>
46 Click this link to edit multiple identities. This is useful if you want to
47 choose between different From-lines for different messages (for example
48 containing your work or your home emailaddress. On the page that appears,
49 you can add as many identities as you like. You will be offered a choice
50 of these when composing a message.<br><br>
52 <b>Reply Citation</b><BR>
53 If you press Reply on a message, you will be presented with the Compose
54 form with the original message quoted. Before this quoted message, a text
55 like <TT>John Doe wrote:</TT> might be prepended (if the message you're replying
56 to originated from John Doe). This is called the citation line. Here you
57 can choose how this line looks.<BR>
58 <UL>
59 <LI><B>No Citation</B><br>
60 Prepends no citation line whatsoever.<br><br>
61 <LI><B>Author Said</B><br>
62 This produces the line: <TT>John Doe Said:</TT> where John Doe will be replaced
63 by whoever the message you're replying to was from.<br><br>
64 <LI><B>Quote Who XML</B><br>
65 This produces the line: <TT>&lt;quote who="John Doe"&gt;</TT>.<br><br>
66 <LI><B>User-Defined</B><br>
67 Enables you to define your own citation line. In the two text boxes below, you
68 can type in the citation start and end. Between these the author name will be
69 inserted.
70 </UL><br><br>
72 <b>Signature</b><br>
73 <i>Optional</i> - Signatures are attached at the bottom of all messages you send
74 out. If you want a signature, you must make sure that the checkbox beside
75 "use a signature" is checked, and then fill in what you want your signature to be
76 in the box below it.
77 <br><br>
78 </description>
79 </section>
81 <section>
82 <title>
83 Display Preferences
84 </title>
85 <description>
86 <b>Theme</b><br>
87 SquirrelMail offers different color themes for your viewing pleasure. You can
88 choose between the many listed there if you so desire.
89 <br><br>
91 <b>Custom Stylesheet</b><br>
92 Changing a theme only changes the colors, a stylesheet may change more, for
93 example the font size used by SquirrelMail.
94 <br><br>
96 <b>Language</b><br>
97 If English isn't your native tongue, you can easily change the language that
98 most things display in. If your desired language is in the list, you can choose
99 it and all future SquirrelMail related messages will be in that language. Note
100 that this doesn't translate incoming email messages or folder names.
101 <br><br>
103 <b>Use Javascript</b><br>
104 One of our main goals in creating SquirrelMail was to have no Javascript in
105 any of our pages. However, some of our developers made a very good address
106 book searching utility that uses Javascript. Some other Javascript functions
107 were added aswell. Rather than remove it, we now
108 give you the option of using
109 pure HTML or allow Javascript aswell. If
110 you don't know what this means, you are safest to choose Autodetect.
111 <br><br>
113 <b>Number of Messages to Index</b><br>
114 This is the number of messages to show at a time in a folder. If there are
115 more than this number in the folder, you will see a "Previous" and "Next" link
116 above and below the listing which will take you to the previous or next
117 messages.
118 <br><br>
120 <b>Enable Page Selector</b><br>
121 Setting this to Yes shows page numbers above and below the message list to
122 quickly jump to a specific page of messages. The number <B>Maximum pages to show</B>
123 can limit how many page numbers will be displayed above and below the
124 message list.<br><br>
126 <b>Wrap incoming text at</b><br>
127 How many characters should we allow before wrapping the text. This prevents
128 messages from scrolling way off the screen. 86 is usually a safe thing to
129 put in here, but you are free to change it to whatever you desire.
130 <br><br>
132 <b>Size of editor window</b><br>
133 How wide do you want your "Compose" box to be? This is the number of characters
134 per line that you will be able to type before wrapping in the Compose section.
135 <br><br>
137 <b>Location of Buttons when Composing</b><br>
138 Where are the buttons Addresses, Save Draft and Send located?<br><br>
140 <b>Addressbook Display Format</B><br>
141 Choose how you want the addressbook to be displayed. If you want maximum
142 compatibility with all browsers, use HTML. Select Javascript if you
143 know your browser supports it, it will display a nicer addressbook.
144 <br><br>
146 <b>Show HTML Version by Default</b><br>
147 If a message you receive is in both text and HTML format, you can choose
148 if you want to see the HTML version (Yes) or the text version (No) by
149 default.<br><br>
151 <b>Include Me in CC when I Reply All</b><br>
152 Reply All sends your reply to all recepients of the original message,
153 including yourself. To leave your own email address out, set this to No.
154 <br><br>
156 <b>Enable Mailer Display</b><BR>
157 When viewing a message, this displays which email program the sender used.
158 <br><br>
160 <b>Display Attached Images with Message</b><br>
161 If someone sends you a message with one or more images attached and you've
162 set this to Yes, the images will be displayed right away when you view
163 the message.
164 <br><br>
166 <b>Enable Subtle Printer Friendly Link</b><br>
167 This determines the way the Printable Version-link will be displayed.
168 <br><br>
170 <b>Enable Printer Friendly Clean Display</b><br>
171 This will clean out the message so the print looks nicer.
172 <br><br>
174 <b>Other Options</b><br>
175 Depending on the configuration of your SquirrelMail installation, some more
176 options might be displayed here. They hopefully should be self-explanatory.
177 <br><br>
179 </description>
180 </section>
182 <section>
183 <title>
184 Message Highlighting
185 </title>
186 <description>
187 The idea for this came because if you are subscribed to many mailing lists,
188 it is very hard to distinguish which messages came from where while reading
189 through the list of messages. With Message Highlighting, you can have the
190 background color of all messages from one mailing list different than the
191 color of another list.<br><br>
193 Just click on [New] to create a new one, or [Edit] to edit an existing one
194 and the options will appear below.<br><br>
196 <b>Identifying Name</b><br>
197 This is simply the name that you see which describes what it is. For
198 example, if you are highlighting messages from your mother, you might
199 set this to "From Mom".
200 <br><br>
202 <b>Color</b><br>
203 This is the actual color that the background will be. You can choose between
204 a number of pre-defined colors that we have selected for you, or you can enter
205 the HEX code for the color that you desire (i.e. a6b492). If you choose to
206 enter your own color, you must also select the radio button in front so that it is
207 checked.
208 <br><br>
210 <b>Match</b><br>
211 Here you can choose the matching phrase. From the drop-down box, you can
212 choose which header field to match against (to, from, subject...) and in the
213 text box, you can enter the phrase to match (
214 <br><br>
215 </description>
216 </section>
218 <section>
219 <title>
220 Folder Preferences
221 </title>
222 <description>
223 <b>Folder Path</b><br>
224 On some systems this will not be displayed. If you don't see this option, just
225 ignore this. On other systems, this is quite a necessary feature. Usually the
226 option that is in there is what should be there. This is the folder in your
227 home directory that holds all your email folders. If you don't understand this,
228 just leave it what it is.
229 <br><br>
231 <b>Trash Folder</b><br>
232 You can choose which folder messages will be sent to when you delete them. If
233 you don't want deleted messages to go to the trash, set this to "Don't use Trash".
234 <br><br>
236 <b>Sent Folder</b><br>
237 You can choose which folder your sent messages will go to. If you don't want
238 these, just set it to "Don't use Sent".
239 <br><br>
241 <b>Draft Folder</b><br>
242 You can choose which folder the messages you save as draft will go to.
243 If you don't want to use this, just set it to "Don't use Drafts".
244 <br><br>
246 <b>Location of folder list</b><br>
247 Determines wether you want the list of folders on the left or right of your
248 window.
249 <br><br>
251 <b>Width of folder list</b><br>
252 With this option, you can select how wide the list of folders will be.
253 If you have very long folder names or large fonts, it is good to set this
254 pretty high. Otherwise, you should set it low so you don't waste screen space.
255 <br><br>
257 <b>Auto refresh folder list</b><br>
258 SquirrelMail has the functionality to automatically refresh the folder listing
259 on the left side of your browser window. This will also update the number of
260 unseen messages that are in each folder. This is a good way to check for unseen
261 messages in the INBOX without having to click on it every time.
262 <br><br>
264 <b>Enable Unread Message Notification</b><br>
265 This option specifies how to display unseen messages in the folder listing on the
266 right side of your browser window. If you set this to No Notification, you will
267 not be notified of unseen messages. If you set it to INBOX, when you have new
268 messages, the INBOX will become bold and a number will appear to the right of it
269 to say how many new messages are in it. If you set it to All Folders, this
270 behavior will happen on all folders. If you notice that loading the folder list
271 is really slow, you can set this to INBOX or None and that should speed it up.
272 <br><br>
274 <b>Unseen message notification type</b><br>
275 When new messages are in a folder, this option tells
276 either to only display the number of new messages or also display the
277 total number of messages in that folder.
278 <br><br>
280 <b>Enable Collapsable Folders</b><br>
281 Collapsable Folders allow you to 'fold' or collapse a folder which contains
282 subfolders so the subfolders will not be displayed. You can collapse a
283 folder by clicking the "-" next to it and expand it again with the "+" sign.
284 Setting this to No disables collapsing.
285 <br><br>
287 <b>Show Clock on Folders Panel</b><br>
288 Choose if you want a clock to be displayed above the folder list and how
289 it should look (Y=year, D=day, H=hour, M=minute, S=second). The option
290 <B>Hour Format</B> below gives you the choice of a 12- or 24-hour clock.
291 <br><br>
293 <b>Memory Search</b><br>
294 If you search a mailbox, the search will be saved for quick access later.
295 This defines how many mailbox searches will be saved.
296 <br><br>
298 </description>
299 </section>
301 <section>
302 <title>
303 Index Order
304 </title>
305 <description>
306 This section gives you control over the message list. You can choose how
307 much information you want in the message list and in what order it should
308 be displayed.
309 <br><br>
310 Use the Up and Down links to move columns around, Del to remove a column
311 from the display and Add to add one.
312 </description>
313 </section>