Updated help files to reflect new functionality.
[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 <DEL>four</DEL><INS> at least five</INS> main parts to the Options:
15       Personal, Display, Message Highlighting, <DEL>and </DEL>Folders<INS> and Index Order.
16       More parts may be available depending on your SquirrelMail installation</INS>.
17       </p>
18    </description>
19 </chapter>
20
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       "jdoe@mydomain.org".
31       <br><br>
32       
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>
37       
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>
44       
45       <INS><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 message (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>
51       
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>
71       </INS>
72       
73       <b>Signature</b><br>
74       <i>Optional</i> - Signatures are attached at the bottom of all messages you send 
75       out.  If you want a signature, you must make sure that the checkbox beside
76       "use a signature" is checked, and then fill in what you want your signature to be
77       in the box below it.
78       <br><br>
79    </description>
80 </section>
81
82 <section>
83    <title>
84       Display Preferences
85    </title>
86    <description>
87       <b>Theme</b><br>
88       SquirrelMail offers different color themes for your viewing pleasure.  You can
89       choose between the many listed there if you so desire.
90       <br><br>
91
92       <INS><b>Custom Stylesheet</b><br>
93       Changing a theme only changes the colors, a stylesheet may change more, for
94       example the font size used by SquirrelMail.
95       <br><br></INS>
96
97       <b>Language</b><br>
98       If English isn't your native tongue, you can easily change the language that
99       most things display in.  If your desired language is in the list, you can choose
100       it and all future SquirrelMail related messages will be in that language.  Note
101       that this doesn't translate incoming email messages or folder names.
102       <br><br>
103
104       <b>Use Javascript<DEL> address book?</DEL></b><br>
105       One of our main goals in creating SquirrelMail was to have no Javascript in
106       any of our pages.  However, some of our developers made a very good address
107       book searching utility that uses Javascript. <INS>Some other Javascript functions
108       were added aswell.</INS> Rather than remove it, we now
109       give you the option of using <DEL>the HTML address book or the Javascript one</DEL>
110       <INS>pure HTML or allow Javascript aswell</INS>.  If
111       you don't know what this means, you are safest to choose <DEL>the HTML address book,
112       but most likely Javascript will work for you</DEL><INS>Autodetect</INS>.
113       <br><br>
114       
115       <b>Number of Messages to Index</b><br>
116       This is the number of messages to show at a time in a folder.  If there are
117       more than this number in the folder, you will see a "Previous" and "Next" link
118       above and below the listing which will take you to the previous or next
119       messages.
120       <br><br>
121       
122       <INS>
123       <b>Enable Page Selector</b><br>
124       Setting this to Yes shows page numbers above and below the message list to
125       quickly jump to a specific page of messages. The number <B>Maximum pages to show</B>
126       can limit how many page numbers will be displayed above and below the
127       message list.<br><br>
128       </INS>      
129       
130       <b>Wrap incoming text at</b><br>
131       How many characters should we allow before wrapping the text.  This prevents
132       messages from scrolling way off the screen.  86 is usually a safe thing to
133       put in here, but you are free to change it to whatever you desire.
134       <br><br>
135       
136       <b>Size of editor window</b><br>
137       How wide do you want your "Compose" box to be?  This is the number of characters
138       per line that you will be able to type before wrapping in the Compose section.
139       <br><br>
140       
141       <INS><b>Location of Buttons when Composing</b><br>
142       Where are the buttons Addresses, Save Draft and Send located?<br><br>
143       
144       <b>Addressbook Display Format</B><br>
145       Choose how you want the addressbook to be displayed. If you want maximum
146       compatibility with all browsers, use HTML. Select Javascript if you
147       know your browser supports it, it will display a nicer addressbook.
148       <br><br>
149       
150       <b>Show HTML Version by Default</b><br>
151       If a message you receive is in both text and HTML format, you can choose
152       if you want to see the HTML version (Yes) or the text version (No) by
153       default.<br><br>
154       
155       <b>Include Me in CC when I Reply All</b><br>
156       Reply All sends your reply to all recepients of the original message,
157       including yourself. To leave your own email address out, set this to No.
158       <br><br>
159       
160       <b>Enable Mailer Display</b><BR>
161       When viewing a message, this displays which email program the sender used.
162       <br><br>
163       
164       <b>Display Attached Images with Message</b><br>
165       If someone sends you a message with one or more images attached and you've
166       set this to Yes, the images will be displayed right away when you view
167       the message.
168       <br><br>
169       
170       <b>Enable Subtle Printer Friendly Link</b><br>
171       This determines the way the Printable Version-link will be displayed.
172       <br><br>
173       
174       <b>Enable Printer Friendly Clean Display</b><br>
175       This will clean out the message so the print looks nicer.
176       <br><br>
177       
178       <b>Other Options</b><br>
179       Depending on the configuration of your SquirrelMail installation, some more
180       options might be displayed here. They hopefully should be self-explanatory.
181       <br><br></INS>
182       
183       <DEL><b>Width of left folder list</b><br>
184       On the left side of your browser window, you will see the list of folders.  With
185       this option, you can select how wide that will be.  If you have very long folder
186       names or large fonts, it is good to set this pretty high.  Otherwise, you should
187       set it low so you don't waste screen space.
188       <br><br>
189       
190       <b>Auto refresh folder list</b><br>
191       SquirrelMail has the functionality to automatically refresh the folder listing
192       on the left side of your browser window.  This will also update the number of
193       unseen messages that are in each folder.  This is a good way to check for unseen
194       messages in the INBOX without having to click on it every time.
195       <br><br></DEL>
196    </description>
197 </section>
198
199 <section>
200    <title>
201       Message Highlighting
202    </title>
203    <description>
204       The idea for this came because if you are subscribed to many mailing lists,
205       it is very hard to distinguish which messages came from where while reading
206       through the list of messages.  With Message Highlighting, you can have the
207       background color of all messages from one mailing list different than the
208       color of another list.<br><br>
209
210       Just click on [New] to create a new one, or [Edit] to edit an existing one
211       and the options will appear below.<br><br>
212       
213       <b>Identifying Name</b><br>
214       This is simply the name that you see which describes what it is.  For
215       example, if you are highlighting messages from your mother, you might
216       set this to "From Mom".
217       <br><br>
218       
219       <b>Color</b><br>
220       This is the actual color that the background will be.  You can choose between
221       a number of pre-defined colors that we have selected for you, or you can enter
222       the HEX code for the color that you desire (i.e.  a6b492).  If you choose to
223       enter your own color, you must also select the radio button in front so that it is
224       checked.
225       <br><br>
226       
227       <b>Match</b><br>
228       Here you can choose the matching phrase.  From the drop-down box, you can 
229       choose which header field to match against (to, from, subject...) and in the
230       text box, you can enter the phrase to match (mom@yahoo.com). 
231       <br><br>
232    </description>
233 </section>
234
235 <section>
236    <title>
237       Folder Preferences
238    </title>
239    <description>
240       <b>Folder Path</b><br>
241       On some systems this will not be displayed.  If you don't see this option, just
242       ignore this.  On other systems, this is quite a necessary feature.  Usually the
243       option that is in there is what should be there.  This is the folder in your
244       home directory that holds all your email folders.  If you don't understand this,
245       just leave it what it is.
246       <br><br>
247
248       <b>Trash Folder</b><br>
249       You can choose which folder messages will be sent to when you delete them. If
250       you don't want deleted messages to go to the trash, set this to "Don't use Trash".
251       <br><br>
252       
253       <b>Sent Folder</b><br>
254       You can choose which folder your sent messages will go to.  If you don't want
255       these, just set it to "Don't use Sent".
256       <br><br>
257
258       <INS><b>Draft Folder</b><br>
259       You can choose which folder the messages you save as draft will go to.
260       If you don't want to use this, just set it to "Don't use Drafts".
261       <br><br></INS>
262       
263       <INS><b>Location of folder list</b><br>
264       Determines wether you want the list of folders on the left or right of your
265       window.
266       <br><br>
267       
268       <b>Width of folder list</b><br>
269       With this option, you can select how wide the list of folders will be.
270       If you have very long folder names or large fonts, it is good to set this
271       pretty high.  Otherwise, you should set it low so you don't waste screen space.
272       <br><br>
273       
274       <b>Auto refresh folder list</b><br>
275       SquirrelMail has the functionality to automatically refresh the folder listing
276       on the left side of your browser window.  This will also update the number of
277       unseen messages that are in each folder.  This is a good way to check for unseen
278       messages in the INBOX without having to click on it every time.
279       <br><br></INS>
280
281       <b><DEL>Unseen</DEL><INS>Enable Unread</INS> Message Notification</b><br>
282       This option specifies how to display unseen messages in the folder listing on the
283       right side of your browser window.  If you set this to No Notification, you will
284       not be notified of unseen messages.  If you set it to INBOX, when you have new
285       messages, the INBOX will become bold and a number will appear to the right of it
286       to say how many new messages are in it.  If you set it to All Folders, this 
287       behavior will happen on all folders.  If you notice that loading the folder list
288       is really slow, you can set this to INBOX or None and that should speed it up.
289       <br><br>
290       
291       <b>Unseen message notification type</b><br>
292       When new messages are in a folder, this option tells
293       <DEL>how to notify you of that</DEL>
294       <INS>either to only display the number of new messages or also display the
295       total number of messages in that folder</INS>.
296       <br><br>
297       
298       <INS><b>Enable Collapsable Folders</b><br>
299       Collapsable Folders allow you to 'fold' or collapse a folder which contains
300       subfolders so the subfolders will not be displayed. You can collapse a
301       folder by clicking the "-" next to it and expand it again with the "+" sign.
302       Setting this to No disables collapsing.
303       <br><br>
304       
305       <b>Show Clock on Folders Panel</b><br>
306       Choose if you want a clock to be displayed above the folder list and how
307       it should look (Y=year, D=day, H=hour, M=minute, S=second). The option
308       <B>Hour Format</B> below gives you the choice of a 12- or 24-hour clock.
309       <br><br>
310       
311       <b>Memory Search</b><br>
312       If you search a mailbox, the search will be saved for quick access later.
313       This defines how many mailbox searches will be saved.
314       <br><br>
315       </INS>
316       
317    </description>
318 </section>
319
320 <section>
321    <title>
322       <INS>Index Order</INS>
323    </title>
324    <description>
325       <INS>This section gives you control over the message list. You can choose how
326       much information you want in the message list and in what order it should
327       be displayed.
328       <br><br>
329       Use the Up and Down links to move columns around, Del to remove a column
330       from the display and Add to add one.</INS>
331    </description>
332 </section>