Give back the message object to those who want it
[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>
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@example.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       <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 />
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 Wrote</b><br />
62       This produces the line: <tt>John Doe Wrote:</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       
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>
80
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 />
90
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 />
95
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 />
102
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 />
112       
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 />
119       
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 />
125       
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 />
131       
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 />
136       
137       <b>Location of Buttons when Composing</b><br />
138       Where are the buttons Addresses, Save Draft and Send located?<br /><br />
139       
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 />
145       
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 />
150       
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 />
155       
156       <b>Enable Mailer Display</b><br />
157       When viewing a message, this displays which email program the sender used.
158       <br /><br />
159       
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 />
165       
166       <b>Other Options</b><br />
167       Depending on the configuration of your SquirrelMail installation, some more
168       options might be displayed here. They hopefully should be self-explanatory.
169       <br /><br />
170       
171    </description>
172 </section>
173
174 <section>
175    <title>
176       Message Highlighting
177    </title>
178    <description>
179       The idea for this came because if you are subscribed to many mailing lists,
180       it is very hard to distinguish which messages came from where while reading
181       through the list of messages.  With Message Highlighting, you can have the
182       background color of all messages from one mailing list different than the
183       color of another list.<br /><br />
184
185       Just click on [New] to create a new one, or [Edit] to edit an existing one
186       and the options will appear below.<br /><br />
187       
188       <b>Identifying Name</b><br />
189       This is simply the name that you see which describes what it is.  For
190       example, if you are highlighting messages from your mother, you might
191       set this to "From Mom".
192       <br /><br />
193       
194       <b>Color</b><br />
195       This is the actual color that the background will be.  You can choose between
196       a number of pre-defined colors that we have selected for you, or you can enter
197       the HEX code for the color that you desire (i.e.  a6b492).  If you choose to
198       enter your own color, you must also select the radio button in front so that it is
199       checked.
200       <br /><br />
201       
202       <b>Match</b><br />
203       Here you can choose the matching phrase.  From the drop-down box, you can 
204       choose which header field to match against (to, from, subject...) and in the
205       text box, you can enter the phrase to match (mom@yahoo.com). 
206       <br /><br />
207    </description>
208 </section>
209
210 <section>
211    <title>
212       Folder Preferences
213    </title>
214    <description>
215       <b>Folder Path</b><br />
216       On some systems this will not be displayed.  If you don't see this option, just
217       ignore this.  On other systems, this is quite a necessary feature.  Usually the
218       option that is in there is what should be there.  This is the folder in your
219       home directory that holds all your email folders.  If you don't understand this,
220       just leave it what it is.
221       <br /><br />
222
223       <b>Trash Folder</b><br />
224       You can choose which folder messages will be sent to when you delete them. If
225       you don't want deleted messages to go to the trash, set this to "Don't use Trash".
226       <br /><br />
227       
228       <b>Sent Folder</b><br />
229       You can choose which folder your sent messages will go to.  If you don't want
230       these, just set it to "Don't use Sent".
231       <br /><br />
232
233       <b>Draft Folder</b><br />
234       You can choose which folder the messages you save as draft will go to.
235       If you don't want to use this, just set it to "Don't use Drafts".
236       <br /><br />
237       
238       <b>Location of folder list</b><br />
239       Determines wether you want the list of folders on the left or right of your
240       window.
241       <br /><br />
242       
243       <b>Width of folder list</b><br />
244       With this option, you can select how wide the list of folders will be.
245       If you have very long folder names or large fonts, it is good to set this
246       pretty high.  Otherwise, you should set it low so you don't waste screen space.
247       <br /><br />
248       
249       <b>Auto refresh folder list</b><br />
250       SquirrelMail has the functionality to automatically refresh the folder listing
251       on the left side of your browser window.  This will also update the number of
252       unseen messages that are in each folder.  This is a good way to check for unseen
253       messages in the INBOX without having to click on it every time.
254       <br /><br />
255
256       <b>Enable Unread Message Notification</b><br />
257       This option specifies how to display unseen messages in the folder listing on the
258       right side of your browser window.  If you set this to No Notification, you will
259       not be notified of unseen messages.  If you set it to INBOX, when you have new
260       messages, the INBOX will become bold and a number will appear to the right of it
261       to say how many new messages are in it.  If you set it to All Folders, this 
262       behavior will happen on all folders.  If you notice that loading the folder list
263       is really slow, you can set this to INBOX and that should speed it up.
264       <br /><br />
265       
266       <b>Unseen message notification type</b><br />
267       When new messages are in a folder, this option tells
268       either to only display the number of new messages or also display the
269       total number of messages in that folder.
270       <br /><br />
271       
272       <b>Enable Collapsable Folders</b><br />
273       Collapsable Folders allow you to 'fold' or collapse a folder which contains
274       subfolders so the subfolders will not be displayed. You can collapse a
275       folder by clicking the "-" next to it and expand it again with the "+" sign.
276       Setting this to No disables collapsing.
277       <br /><br />
278       
279       <b>Show Clock on Folders Panel</b><br />
280       Choose if you want a clock to be displayed above the folder list and how
281       it should look (Y=year, D=day, H=hour, M=minute, S=second). The option
282       <b>Hour Format</b> below gives you the choice of a 12- or 24-hour clock.
283       <br /><br />
284       
285       <b>Memory Search</b><br />
286       If you search a mailbox, the search will be saved for quick access later.
287       This defines how many mailbox searches will be saved.
288       <br /><br />
289       
290    </description>
291 </section>
292
293 <section>
294    <title>
295       Index Order
296    </title>
297    <description>
298       This section gives you control over the message list. You can choose how
299       much information you want in the message list and in what order it should
300       be displayed.
301       <br /><br />
302       Use the Up and Down links to move columns around, Del to remove a column
303       from the display and Add to add one.
304    </description>
305 </section>