| blob | d05d294552d677cc188dca779c45075eb8c1f496 |
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_advanced">
3 <title>Advanced features</title>
4 <section id="adv_actions">
5 <title>Actions</title>
6 <para>
7 Actions allow you to use all the power of the Unix command-line with
8 your emails. You can define various commands, taking parameters such
9 as the current email file, a list of emails, the currently selected
10 text, and so on. In this way, you'll be able to perform various tasks
11 such as editing a raw mail in your text editor,
12 <emphasis>hide</emphasis> what you mean using ROT-13, apply patches
13 contained in emails directly, and so on. The only limit is your
14 imagination. You can create and configure Actions via the
15 <quote>/Configuration/Actions...</quote> menu.
16 </para>
17 <para>
18 The <quote>Tools/Actions/</quote> menu will contain one submenu
19 item for each action that you have created. When you have selected
20 one or more messages in the Message List, or are viewing a message
21 in the Message View, selecting one of these menu items will invoke
22 the action, and, depending on how it was defined, will pass the
23 message(s) to it.
24 </para>
25 <para>
26 Additionally, it is possible to add toolbar entries for your
27 actions. To do so, open the <quote>Configuration/Preferences</quote>
28 menu and select <quote>Toolbars/Main Window</quote>.
29 Select <quote>User Action</quote> in the <quote>Item type</quote>
30 dropdown menu, then select the Action in the <quote>Event executed on click</quote>
31 dropdown menu, and click the <quote>Icon</quote> button to select the
32 icon that you want to use.
33 </para>
34 <blockquote>
35 <example>
36 <title>Simple <quote>Open With...</quote></title>
37 <variablelist>
38 <varlistentry>
39 <term>
40 Menu name: <emphasis>Open with/kate</emphasis>
41 Command Line: <command>kate %p</command>
42 </term>
43 <listitem>
44 <para>
45 Opens the file of the selected decoded MIME part
46 (<emphasis>%p</emphasis>) with the <emphasis>kate</emphasis> text
47 editor.
48 </para>
49 </listitem>
50 </varlistentry>
51 </variablelist>
52 </example>
53 <example>
54 <title>Spam management using <ulink
55 url="https://bogofilter.sourceforge.io/">Bogofilter</ulink>
56 </title>
57 <variablelist>
58 <varlistentry>
59 <term>
60 Menu name: <emphasis>Bogofilter/Mark as Ham</emphasis>
61 Command Line: <command>bogofilter -n -v -B "%f"</command>
62 </term>
63 <listitem>
64 <para>
65 Marks the currently selected mails (<emphasis>%f</emphasis>) as
66 <quote>not spam</quote> using <emphasis>Bogofilter</emphasis>.
67 </para>
68 </listitem>
69 </varlistentry>
70 <varlistentry>
71 <term>
72 Menu name: <emphasis>Bogofilter/Mark as Spam</emphasis>
73 Command Line: <command>bogofilter -s -v -B "%f"</command>
74 </term>
75 <listitem>
76 <para>
77 Marks the currently selected mails (<emphasis>%f</emphasis>) as
78 <quote>spam</quote> using <emphasis>Bogofilter</emphasis>.
79 </para>
80 </listitem>
81 </varlistentry>
82 </variablelist>
83 </example>
84 <example>
85 <title>Search DuckDuckGo using an external script</title>
86 <variablelist>
87 <varlistentry>
88 <term>
89 Menu name: <emphasis>Search/DuckDuckGo</emphasis>
90 Command Line: <command>|/path/to/ddg_search.pl</command>
91 </term>
92 <listitem>
93 <para>
94 Searches DuckDuckGo for the currently selected text
95 (<emphasis>|</emphasis>) using the external script <emphasis><ulink
96 url="https://www.claws-mail.org/tools.php"
97 >ddg_search.pl</ulink></emphasis>.
98 </para>
99 </listitem>
100 </varlistentry>
101 </variablelist>
102 </example>
103 </blockquote>
104 </section>
105 <section id="adv_templates">
106 <title>Templates</title>
107 <para>
108 Templates are used in composition windows, and act as a model for
109 emails. Templates can be filled with static text and dynamic parts,
110 such as the original sender's name (<quote>Dear %N, ...</quote>),
111 the date, etc. When applying a template, the dynamic fields will be
112 replaced with the relevant values. You can configure templates via
113 the <quote>Tools</quote> menu.
114 </para><para>
115 When applying a template, you will be asked to <quote>Insert</quote>
116 or <quote>Replace</quote>, the difference between replacing and
117 inserting is only concerned with the message body.
118 <quote>Replace</quote> will replace the current composition window
119 message body with the body defined in the template, clearing it if
120 the template body is empty. <quote>Insert</quote> will insert
121 the template's body, if set, at the current cursor position.
122 </para><para>
123 Whether you choose to Insert or Replace, any To, Cc or Bcc field
124 that is defined in the template will be appended to the compose
125 window's recipients list. If it is defined, the template's Subject
126 will always replace the compose window's Subject.
127 </para><para>
128 Symbols can be used in all parts of the templates and will be
129 substituted with their respective dynamic value if possible, otherwise
130 no value will be used. This often makes more sense if you apply a
131 template when replying or forwarding, otherwise most of the symbols
132 value will be undefined. There is no restriction on which symbols can
133 be used in template parts, even if inserting the body (%M or %Q) may
134 make no sense in common situations.
135 </para><para>
136 When applying a template, the body is processed first, then the To, Cc,
137 Bcc and Subject fields follow.
138 </para><para>
139 Further information and examples of usage can be found in the
140 user-contributed FAQ on the Claws Mail website <ulink
141 url="https://www.claws-mail.org/faq/"
142 >www.claws-mail.org/faq/</ulink>.
143 </para>
144 </section>
145 <section id="adv_processing">
146 <title>Processing</title>
147 <para>
148 Processing rules are the same as Filtering rules, except that they are
149 applied when entering a folder or when manually applied from a folder's
150 context menu and apply only to this folder. You can use them to automatically
151 move old mails into an archive folder, or for further dispatching of
152 emails, and more. You can set each folder's Processing rules by
153 right-clicking on it.
154 </para><para>
155 Processing rules are accompanied by Pre-processing and Post-processing
156 rules. Like Processing rules, they apply when opening a folder or manually
157 applying them from a folder's context menu, but like Filtering rules,
158 they are shared across all folders. You can configure them from the
159 <quote>Tools</quote> menu. Pre-processing rules are executed before the
160 folder's specific Processing rules, while Post-processing rules are executed
161 afterwards.
162 </para>
163 </section>
164 <section id="adv_colour_labels">
165 <title>Colour Labels</title>
166 <para>
167 Colour labels can be used to denote a message as having a particular
168 significance. To set a colour label simply right-click a message in the
169 Message List and use the <quote>Color label</quote> submenu.
170 </para><para>
171 Colour labels are user-configurable. Both the colour and the label can
172 be set by the user. Preferences can be found on the
173 <quote>Configuration/Preferences/Display/Colors</quote> page.
174 </para>
175 </section>
176 <section id="adv_tags">
177 <title>Tags</title>
178 <para>
179 Tags are short text notes which may be set on messages. They are useful
180 for classifying messages with your own words. These tags can be used
181 later to find the mails with Quick Search or to manage them with
182 filtering or processing rules, for example.
183 </para><para>
184 Tagged messages are displayed with a yellow background at the top of
185 the Message View. This line shows all tags associated with the
186 message. You can enable the "Tags" column in the Message List, so
187 tagged items can be seen without having to open the message.
188 </para><para>
189 Setting of tags is done by right-clicking on the message in the Message
190 List or by the corresponding option in Message menu. A panel with the
191 existing tags is shown and you can select some of them or just add a
192 new one. Removal of existing tags is also allowed, of course.
193 </para><para>
194 Once tags exist it's even easier, as the context menu allows you to
195 set and unset tags with just one click to the selected messages.
196 Mixed selections of tagged and untagged messages are allowed, and
197 Claws Mail is clever enough to do what you want to do in any case.
198 </para>
199 </section>
200 <section id="adv_ml_support">
201 <title>Mailing-List support</title>
202 <para>
203 Claws Mail offers mailing-list support from the
204 <quote>Message/Mailing-List/</quote> submenu. When you have a
205 mailing-list message selected, the submenu allows you to quickly
206 initiate subscribing, unsubscribing, posting, getting help, contacting
207 the list owner, and viewing the list archive; either by opening a new
208 Compose window with the appropriate address pre-filled, or by opening
209 the URL in your web browser.
210 </para>
211 </section>
212 <section id="adv_plugins">
213 <title>Plugins</title>
214 <para>
215 Plugins are the mechanism for extending Claws Mail' capabilities.
216 For example, imagine that you want to store your mails in a remote
217 <acronym>SQL</acronym> database. In most mailers out there this is
218 simply impossible without reworking the internals of the mailer. With
219 Claws Mail you can simply write a plugin to achieve the task.
220 </para><para>
221 This is just an example of the possibilities. A good number of plugins
222 developed for Claws Mail already exist, and more are to come. The
223 <link linkend="ch_plugins">Extending Claws Mail section</link>
224 gives details of them.
225 </para>
226 </section>
227 <section id="deploying">
228 <title>Deploying Claws Mail</title>
229 <para>
230 The initial configuration wizard tries to guess various fields using
231 information gathered from the system, such as username, hostname, and
232 more. As it is oriented towards general use, the default values often
233 have to be fixed. However, this wizard is customisable, in a manner
234 designed to allow system administrators to deploy Claws Mail easily
235 over various users of one machine, or even over multiple machines
236 installed via some replication tool.
237 </para><para>
238 The first part consists of creating a wizard configuration template
239 and setting the various default parameters of a new Claws Mail
240 installation.
241 </para>
242 <itemizedlist>
243 <listitem>
244 <para>
245 Start with a user who does not have a <filename class="directory"
246 >~/.claws-mail</filename> directory, ideally a new user.
247 </para>
248 </listitem>
249 <listitem>
250 <para>
251 Start Claws Mail and go through the wizard. The values you fill in
252 will be of no use for the future deployment, so you can click
253 next-next-next.
254 </para>
255 </listitem>
256 <listitem>
257 <para>
258 Once the wizard is finished and you have Claws Mail' main window
259 opened, configure the various defaults you want to have in the master.
260 You can load plugins, add people or LDAP servers in the addressbook,
261 create filtering rules, and so on.
262 </para>
263 </listitem>
264 <listitem>
265 <para>
266 If needed, and if the deployed Claws Mail will use MH folders, you
267 can create subdirectories in the mailbox.
268 </para>
269 </listitem>
270 <listitem>
271 <para>
272 Next, quit Claws Mail.
273 </para>
274 </listitem>
275 <listitem>
276 <para>
277 Now, edit the newly created wizard template file,
278 <filename>~/.claws-mail/accountrc.tmpl</filename>. In this file,
279 you will see different variables, corresponding to the wizard's fields.
280 You can leave some commented, in which case the usual default will be
281 used, or specify values or variables. Not all fields can contain
282 variables; for example, <literal>smtpauth</literal>,
283 <literal>smtpssl</literal> and <literal>recvssl</literal> are booleans,
284 either 0 or 1, and <literal>recvtype</literal> is an integer value. The
285 other fields, like <literal>name</literal>, <literal>email</literal>,
286 or <literal>recvuser</literal>, are parsed by the wizard and the
287 variables they contain are replaced by values. This allows you to
288 specify everything as needed for your site, even if you have strange
289 server names or server logins.
290 </para>
291 </listitem>
292 <listitem>
293 <para>
294 Save this file, and delete both
295 <filename>~/.claws-mail/accountrc</filename>, (which contains your
296 dummy account) and
297 <filename>~/.claws-mail/folderlist.xml</filename>, (so that the
298 folder tree will be correctly parsed for new users). Recursively copy
299 <filename class="directory">.claws-mail</filename> to
300 <filename class="directory">/etc/skel/</filename>; if the deployed
301 Claws Mail will use MH folders, also copy the created
302 <filename class="directory">Mail</filename> directory. chown all of
303 <filename class="directory">/etc/skel/.claws-mail</filename>
304 and <filename class="directory">/etc/skel/Mail</filename> to
305 <literal>root:root</literal> for security reasons.
306 </para>
307 </listitem>
308 <listitem>
309 <para>
310 Test! Create a new user, login as that user, run Claws Mail. If you
311 filled everything as you wanted, this user will just have to fill in
312 his passwords.
313 </para>
314 </listitem>
315 <listitem>
316 <para>
317 Now, if you're creating a master for a site-wide deployment, you can
318 continue with this process. If you were just doing it for one machine,
319 you're done!
320 </para>
321 </listitem>
322 </itemizedlist>
323 <para>
324 Here are the different variables of the <filename>accountrc.tmpl</filename>
325 file:
326 </para>
327 <variablelist>
328 <varlistentry>
329 <term><literal>domain</literal></term>
330 <listitem>
331 <para>
332 Your domain name (example.com). If not set, it'll be extracted from the
333 hostname.
334 </para>
335 </listitem>
336 </varlistentry>
337 <varlistentry>
338 <term><literal>name</literal></term>
339 <listitem>
340 <para>
341 The user's name. If not set, it'll be extracted from Unix login
342 information, which is usually ok.
343 </para>
344 </listitem>
345 </varlistentry>
346 <varlistentry>
347 <term><literal>email</literal></term>
348 <listitem>
349 <para>
350 The user's email. If not set, it'll be extracted from
351 <literal>$name</literal> and <literal>$domain</literal>.
352 </para>
353 </listitem>
354 </varlistentry>
355 <varlistentry>
356 <term><literal>organization</literal></term>
357 <listitem>
358 <para>
359 Your organization. If not set, it'll be empty.
360 </para>
361 </listitem>
362 </varlistentry>
363 <varlistentry>
364 <term><literal>smtpserver</literal></term>
365 <listitem>
366 <para>
367 The SMTP server to use. If not set, it'll be
368 <literal>smtp.$domain</literal>.
369 </para>
370 </listitem>
371 </varlistentry>
372 <varlistentry>
373 <term><literal>smtpauth</literal></term>
374 <listitem>
375 <para>
376 0 or 1. Whether to authenticate on the SMTP server. If not set, it'll
377 be 0.
378 </para>
379 </listitem>
380 </varlistentry>
381 <varlistentry>
382 <term><literal>smtpuser</literal></term>
383 <listitem>
384 <para>
385 The login on the SMTP server. If not set, it'll be empty (same login as
386 for reception will be used).
387 </para>
388 </listitem>
389 </varlistentry>
390 <varlistentry>
391 <term><literal>smtppass</literal></term>
392 <listitem>
393 <para>
394 The password on the SMTP server. If not set, it'll be empty (if
395 <literal>smtppass</literal> is empty but <literal>smtpuser</literal> is
396 not, the user will be asked for the password).
397 </para>
398 </listitem>
399 </varlistentry>
400 <varlistentry>
401 <term><literal>recvtype</literal></term>
402 <listitem>
403 <para>
404 The type of server to receive from. 0 for POP3, 3 for IMAP4, 5 for a
405 local MBOX file. If not set, it'll be 0 (POP3).
406 </para>
407 </listitem>
408 </varlistentry>
409 <varlistentry>
410 <term><literal>recvserver</literal></term>
411 <listitem>
412 <para>
413 The reception server. If not set, it'll be
414 <literal>(pop|imap).$domain</literal>, depending on
415 <literal>$recvtype</literal>.
416 </para>
417 </listitem>
418 </varlistentry>
419 <varlistentry>
420 <term><literal>recvuser</literal></term>
421 <listitem>
422 <para>
423 The login on the reception server. If not set, it'll be extracted from
424 the Unix login information.
425 </para>
426 </listitem>
427 </varlistentry>
428 <varlistentry>
429 <term><literal>recvpass</literal></term>
430 <listitem>
431 <para>
432 The password on the reception server. If not set, it'll be empty (the
433 user will be asked for it once per session).
434 </para>
435 </listitem>
436 </varlistentry>
437 <varlistentry>
438 <term><literal>imapdir</literal></term>
439 <listitem>
440 <para>
441 The IMAP subdirectory. If not set, it'll be empty, which is often
442 sufficient.
443 </para>
444 </listitem>
445 </varlistentry>
446 <varlistentry>
447 <term><literal>mboxfile</literal></term>
448 <listitem>
449 <para>
450 The MBOX file to receive from if <literal>$recvtype</literal> is 5.
451 If not set, <literal>/var/mail/$LOGIN</literal>.
452 </para>
453 </listitem>
454 </varlistentry>
455 <varlistentry>
456 <term><literal>mailbox</literal></term>
457 <listitem>
458 <para>
459 The MH mailbox to store mail in (for <literal>$recvtype</literal> 0 or
460 5). If not set, it'll be <quote>Mail</quote>.
461 </para>
462 </listitem>
463 </varlistentry>
464 <varlistentry>
465 <term><literal>smtpssl</literal></term>
466 <listitem>
467 <para>
468 0 or 1. Whether to use SSL for sending mail. If not set, it'll be 0.
469 </para>
470 </listitem>
471 </varlistentry>
472 <varlistentry>
473 <term><literal>recvssl</literal></term>
474 <listitem>
475 <para>
476 0 or 1. Whether to use SSL for receiving mail. If not set, it'll be 0.
477 </para>
478 </listitem>
479 </varlistentry>
480 </variablelist>
481 <para>
482 Here are the different variables you can use in the
483 <literal>domain</literal>, <literal>name</literal>,
484 <literal>email</literal>, <literal>organization</literal>,
485 <literal>smtpserver</literal>, <literal>smtpuser</literal>,
486 <literal>smtppass</literal>, <literal>recvserver</literal>,
487 <literal>recvuser</literal>, <literal>recvpass</literal>,
488 <literal>imapdir</literal>, <literal>mboxfile</literal> and
489 <literal>mailbox</literal> fields:
490 </para>
491 <variablelist>
492 <varlistentry>
493 <term><literal>$DEFAULTDOMAIN</literal></term>
494 <listitem>
495 <para>
496 The domain name as extracted from Unix hostname information.
497 Often wrong.
498 </para>
499 </listitem>
500 </varlistentry>
501 <varlistentry>
502 <term><literal>$DOMAIN</literal></term>
503 <listitem>
504 <para>
505 The domain name as set in the domain variable, the first of the
506 template file.
507 </para>
508 </listitem>
509 </varlistentry>
510 <varlistentry>
511 <term><literal>$USERNAME</literal></term>
512 <listitem>
513 <para>The user's real name.</para>
514 </listitem>
515 </varlistentry>
516 <varlistentry>
517 <term><literal>$LOGIN</literal></term>
518 <listitem>
519 <para>The user's Unix login.</para>
520 </listitem>
521 </varlistentry>
522 <varlistentry>
523 <term><literal>$NAME_MAIL</literal></term>
524 <listitem>
525 <para>
526 The user's real name as set in the name variable of the template field,
527 in lowercase and with spaces replaced by dots.
528 <quote>Colin Leroy</quote> becomes <quote>colin.leroy</quote>.
529 </para>
530 </listitem>
531 </varlistentry>
532 <varlistentry>
533 <term><literal>$EMAIL</literal></term>
534 <listitem>
535 <para>
536 The email address as set in the email variable of the template field.
537 </para>
538 </listitem>
539 </varlistentry>
540 </variablelist>
541 <para>
542 Be sure not to use a variable before defining it.
543 </para>
544 </section>
545 <section id="adv_hidden">
546 <title>Hidden preferences</title>
547 <para>
548 There are a number of hidden preferences in Claws Mail, preferences
549 that some users who we wanted to please couldn't live without, but
550 which did not have a place in the GUI in our opinion. You can find the
551 following, and change them while Claws Mail is not running, in
552 <filename>~/.claws-mail/clawsrc</filename>.
553 </para>
554 <para>
555 There's a small tool written in Perl-GTK called Clawsker which
556 provides a user-friendly GUI for tweaking these settings instead of
557 direct editing of <filename>clawsrc</filename>. You can read more
558 about it on the <ulink
559 url="https://www.claws-mail.org/clawsker.php">Clawsker page</ulink>.
560 </para>
561 <variablelist>
562 <varlistentry>
563 <term><literal>address_search_wildcard</literal></term>
564 <listitem>
565 <para>
566 TAB-address completion in the Compose window and other GUI places will
567 match any part of the string ('1') or just the start of the string ('0').
568 Default value is '1'.
569 </para>
570 </listitem>
571 </varlistentry>
572 <varlistentry>
573 <term><literal>addressbook_use_editaddress_dialog</literal></term>
574 <listitem>
575 <para>
576 Use a separate dialogue to edit a person's details if set to '1'
577 (default). '0' will use a form embedded in the addressbook's main
578 window.
579 </para>
580 </listitem>
581 </varlistentry>
582 <varlistentry>
583 <term><literal>bold_marked</literal></term>
584 <listitem>
585 <para>
586 Show marked messages in the message list of summary view using a
587 bold font when set to '1'. '0' (default) will use normal font.
588 </para>
589 </listitem>
590 </varlistentry>
591 <varlistentry>
592 <term><literal>bold_unread</literal></term>
593 <listitem>
594 <para>
595 Show unread messages in the message list of summary view using a
596 bold font when set to '1' (default). '0' will use normal font.
597 </para>
598 </listitem>
599 </varlistentry>
600 <varlistentry>
601 <term><literal>cache_max_mem_usage</literal></term>
602 <listitem>
603 <para>
604 The maximum amount of memory to use to cache messages, in kB. It will
605 try to keep the memory usage below this value, but it will always use
606 the assigned amount of memory for speed gain. Default value is '4096'.
607 </para>
608 </listitem>
609 </varlistentry>
610 <varlistentry>
611 <term><literal>cache_min_keep_time</literal></term>
612 <listitem>
613 <para>
614 The minimum time in minutes to keep a folder cache in memory. Caches
615 more recent than this time will not be freed, even if the memory usage
616 is too high. You should probably set this value higher than your
617 mail check interval. Otherwise the cache will always be freed between
618 checks even if the folder is accessed on every check, which will cause
619 much disk I/O. Default value is '15'.
620 </para>
621 </listitem>
622 </varlistentry>
623 <varlistentry>
624 <term><literal>compose_no_markup</literal></term>
625 <listitem>
626 <para>
627 Don't use bold and italic text in Compose dialogue's account selector
628 if set to '1'. Default value is '0' (use markup).
629 </para>
630 </listitem>
631 </varlistentry>
632 <varlistentry>
633 <term><literal>default_header_color</literal></term>
634 <term><literal>default_header_bgcolor</literal></term>
635 <listitem>
636 <para>
637 Foreground and background colors to use for the Compose window's header
638 entry values. Default values are '#000000' (black) and '#f5f6be' (pale
639 yellow), respectively.
640 </para>
641 </listitem>
642 </varlistentry>
643 <varlistentry>
644 <term><literal>emphasis_color</literal></term>
645 <listitem>
646 <para>
647 The colour used for the X-Mailer line in Message View when its value
648 is Claws Mail. Default value is '#0000CF' (medium blue).
649 </para>
650 </listitem>
651 </varlistentry>
652 <varlistentry>
653 <term><literal>enable_avatars</literal></term>
654 <listitem>
655 <para>
656 Enables capture and/or rendering of internal avatars (Face and
657 also X-Face headers if built with compface support).
658 '0' disables both, '1' enables capture only, '2' enables rendering
659 only and '3' enables both. Default value is '3'.
660 </para>
661 <para>
662 Note that external plugins already providing these features may
663 disable partially or completely this to speed up process,
664 regardless of the configured value.
665 </para>
666 </listitem>
667 </varlistentry>
668 <varlistentry>
669 <term><literal>enable_hscrollbar</literal></term>
670 <listitem>
671 <para>
672 Enable the horizontal scrollbar in the message list of Summary View
673 if set to '1' (default). Set it to '0' to disable.
674 </para>
675 </listitem>
676 </varlistentry>
677 <varlistentry>
678 <term><literal>enable_swap_from</literal></term>
679 <listitem>
680 <para>
681 Display the recipient's email address (preceded by an arrow) in the From column
682 when displaying a message which you have sent.
683 Default value is '0'.
684 </para>
685 </listitem>
686 </varlistentry>
687 <varlistentry>
688 <term><literal>folder_search_wildcard</literal></term>
689 <listitem>
690 <para>
691 The type-ahead function in the Select Folder window will match any
692 part of the folder name ('1') or just the start of the folder
693 name ('0'). Default value is '1'.
694 </para>
695 </listitem>
696 </varlistentry>
697 <varlistentry>
698 <term><literal>folderview_vscrollbar_policy</literal></term>
699 <listitem>
700 <para>
701 Specify the policy of vertical scrollbar of Folder List:
702 '0' is always shown, '1' is automatic and '2' is always hidden.
703 Default value is '0'.
704 </para>
705 </listitem>
706 </varlistentry>
707 <varlistentry>
708 <term><literal>hide_timezone</literal></term>
709 <listitem>
710 <para>
711 If enabled ('1') the timezone in date headers is set to the
712 unknown timezone value, as specified in section 3 of the RFC
713 5322. Default value is '0'.
714 </para>
715 </listitem>
716 </varlistentry>
717 <varlistentry>
718 <term><literal>hover_timeout</literal></term>
719 <listitem>
720 <para>
721 Time in milliseconds that will cause a folder tree to expand
722 when the mouse cursor is held over it during drag 'n' drop.
723 Default value is '500'.
724 </para>
725 </listitem>
726 </varlistentry>
727 <varlistentry>
728 <term><literal>live_dangerously</literal></term>
729 <listitem>
730 <para>
731 Don't ask for confirmation before definitive deletion of emails when
732 set to '1'. Default value is '0'.
733 </para>
734 </listitem>
735 </varlistentry>
736 <varlistentry>
737 <term><literal>log_error_color</literal></term>
738 <term><literal>log_in_color</literal></term>
739 <term><literal>log_msg_color</literal></term>
740 <term><literal>log_out_color</literal></term>
741 <term><literal>log_warn_color</literal></term>
742 <term><literal>log_status_ok_color</literal></term>
743 <term><literal>log_status_nok_color</literal></term>
744 <term><literal>log_status_skip_color</literal></term>
745 <listitem>
746 <para>
747 The colours used in the log window. Default values are: '#af0000'
748 (dark red), '#000000' (black), '#00af00' (dark lime green),
749 '#0000ef' (blue), '#af0000' (dark red), '#00af00' (dark lime green),
750 '#0000af' (dark blue) and '#aa00aa' (dark magenta) respectively.
751 </para>
752 </listitem>
753 </varlistentry>
754 <varlistentry>
755 <term><literal>master_passphrase_pbkdf2_rounds</literal></term>
756 <listitem>
757 <para>
758 Number of rounds (or iterations) to use in PBKDF2 function when
759 computing next master passphrase key derivation. Currently stored master
760 passphrase KD is not affected by changing this preference.
761 Default value is '50000'.
762 </para>
763 </listitem>
764 </varlistentry>
765 <varlistentry>
766 <term><literal>msgview_date_format</literal></term>
767 <listitem>
768 <para>
769 '0' or '1'. Use the same user-defined date format in the Message
770 View as is used in the Message List. Default is '0', turned off.
771 </para>
772 </listitem>
773 </varlistentry>
774 <varlistentry>
775 <term><literal>next_on_delete</literal></term>
776 <listitem>
777 <para>
778 '0' or '1'. Controls the message selection after deleting, moving, or
779 trashing a message. Default is '0', select previous message.
780 </para>
781 </listitem>
782 </varlistentry>
783 <varlistentry>
784 <term><literal>outgoing_fallback_to_ascii</literal></term>
785 <listitem>
786 <para>
787 '0' or '1'. The outgoing encoding of a message will use 7bit US-ASCII
788 whenever it is suitable for the message content, ignoring the
789 <quote>Outgoing encoding</quote> option unless it is necessary. Turning
790 this option off forces the user-defined encoding to be used, regardless
791 of message content. Default is '1', turned on.
792 </para>
793 </listitem>
794 </varlistentry>
795 <varlistentry>
796 <term><literal>primary_paste_unselects</literal></term>
797 <listitem>
798 <para>
799 '0' or '1'. Causes the primary buffer to be cleared and the insertion
800 point to be repositioned when the middle mouse button is used
801 for pasting text. Default is '0', turned off.
802 </para>
803 </listitem>
804 </varlistentry>
805 <varlistentry>
806 <term><literal>qs_active_color</literal></term>
807 <term><literal>qs_active_bgcolor</literal></term>
808 <term><literal>qs_error_color</literal></term>
809 <term><literal>qs_error_bgcolor</literal></term>
810 <listitem>
811 <para>
812 Foreground and background colors to use in the QuickSearch field when
813 the search is active and when there is a syntax error.
814 Default values are '#000000' (black), '#f5f6be' (pale yellow), '#000000'
815 (black), and '#ff7070' (pale red), respectively.
816 </para>
817 </listitem>
818 </varlistentry>
819 <varlistentry>
820 <term><literal>qs_press_timeout</literal></term>
821 <listitem>
822 <para>
823 Quicksearch type-ahead timeout (in ms): while you're typing in the
824 quicksearch value area in type-ahead mode, this is the delay between
825 two keystrokes after which the search is performed. By default: 500.
826 </para>
827 </listitem>
828 </varlistentry>
829 <varlistentry>
830 <term><literal>respect_flowed_format</literal></term>
831 <listitem>
832 <para>
833 '0' or '1'. Respect <literal>format=flowed</literal> on
834 <literal>text/plain</literal> message parts. This
835 will cause some mails to have long lines, but will fix some URLs
836 that would otherwise be wrapped. Default is '0', turned off.
837 </para>
838 </listitem>
839 </varlistentry>
840 <varlistentry>
841 <term><literal>rewrite_first_from</literal></term>
842 <listitem>
843 <para>
844 '0' or '1'. This works around a limitation of some servers with
845 'overly-liberal parsers'. When this is turned on and the Content-
846 Transfer-Encoding is set to 8bit or 7bit, in a message body starting with
847 'From ' the 'From ' will become '=46rom ' and the Content-Transfer-Encoding
848 will be changed to Quoted-Printable. When it is turned off no such modification
849 will be made but it is very likely that an MTA will convert the 'From ' to
850 '>From '. See RFC 4155 for further details. Default value is '1', turned on.
851 </para>
852 </listitem>
853 </varlistentry>
854 <varlistentry>
855 <term><literal>save_parts_readwrite</literal></term>
856 <listitem>
857 <para>
858 If set to '1' saves temporary files when opening attachments with
859 write bit set. Default value is '0', temporary files are read only.
860 </para>
861 </listitem>
862 </varlistentry>
863 <varlistentry>
864 <term><literal>show_compose_margin</literal></term>
865 <listitem>
866 <para>
867 '0' or '1'. Adds margins to the message text area in the Compose window.
868 Default is '0', turned off.
869 </para>
870 </listitem>
871 </varlistentry>
872 <varlistentry>
873 <term><literal>show_inline_attachments</literal></term>
874 <listitem>
875 <para>
876 '0' or '1'. Show inline attachments in MimeView.
877 Default is '1', turned on.
878 </para>
879 </listitem>
880 </varlistentry>
881 <varlistentry>
882 <term><literal>skip_ssl_cert_check</literal></term>
883 <listitem>
884 <para>
885 Disables the verification of SSL certificates when set to '1'.
886 Default value is '0'.
887 </para>
888 </listitem>
889 </varlistentry>
890 <varlistentry>
891 <term><literal>statusbar_update_step</literal></term>
892 <listitem>
893 <para>
894 Update stepping in progress bars. Default value is '10'.
895 </para>
896 </listitem>
897 </varlistentry>
898 <varlistentry>
899 <term><literal>stripes_color_offset</literal></term>
900 <listitem>
901 <para>
902 Specify the value to use when creating alternately coloured lines in
903 <literal>GtkTreeView</literal> components. The smaller the value, the
904 less visible the difference in the alternating colours of the lines.
905 Default value is '4000'.
906 </para>
907 </listitem>
908 </varlistentry>
909 <varlistentry>
910 <term><literal>tags_color</literal></term>
911 <term><literal>tags_bgcolor</literal></term>
912 <listitem>
913 <para>
914 Foreground and background colors to use when displaying tags.
915 Default values are '#000000' (black) and '#f5f6be' (pale yellow),
916 respectively.
917 </para>
918 </listitem>
919 </varlistentry>
920 <varlistentry>
921 <term><literal>textview_cursor_visible</literal></term>
922 <listitem>
923 <para>
924 Display the cursor in the message view when set to '1'.
925 Default value is '0'.
926 </para>
927 </listitem>
928 </varlistentry>
929 <varlistentry>
930 <term><literal>thread_by_subject_max_age</literal></term>
931 <listitem>
932 <para>
933 Number of days to include a message in a thread when using
934 <quote>Thread using subject in addition to standard headers</quote>.
935 Default value is '10'.
936 </para>
937 </listitem>
938 </varlistentry>
939 <varlistentry>
940 <term><literal>toolbar_detachable</literal></term>
941 <listitem>
942 <para>
943 Show handles in the toolbars when set to '1'. Default value is '0'.
944 </para>
945 </listitem>
946 </varlistentry>
947 <varlistentry>
948 <term><literal>type_any_header</literal></term>
949 <listitem>
950 <para>
951 Allows to type any header on the compose window header entries
952 when set to '1'. By default ('0') only the entries available
953 from the combobox can be selected.
954 </para>
955 </listitem>
956 </varlistentry>
957 <varlistentry>
958 <term><literal>two_line_vertical</literal></term>
959 <listitem>
960 <para>
961 Spread message list information over two lines when using the
962 three column layout when set to '1' (default). Set it to '0'
963 to use only one line.
964 </para>
965 </listitem>
966 </varlistentry>
967 <varlistentry>
968 <term><literal>unsafe_ssl_certs</literal></term>
969 <listitem>
970 <para>
971 Allows Claws Mail to remember multiple SSL certificates for a given
972 server/port when set to '1'. This is disabled by default ('0').
973 </para>
974 </listitem>
975 </varlistentry>
976 <varlistentry>
977 <term><literal>use_networkmanager</literal></term>
978 <listitem>
979 <para>
980 Use NetworkManager to switch offline automatically. This is enabled
981 by default ('1'). Set it to '0' to ignore NetworkManager.
982 </para>
983 </listitem>
984 </varlistentry>
985 <varlistentry>
986 <term><literal>use_stripes_everywhere</literal></term>
987 <listitem>
988 <para>
989 Enable alternately coloured lines in <literal>GtkTreeView</literal>
990 components when set to '1' (default). Set it to '0' to disable them.
991 </para>
992 </listitem>
993 </varlistentry>
994 <varlistentry>
995 <term><literal>use_stripes_in_summaries</literal></term>
996 <listitem>
997 <para>
998 Enable alternately coloured lines in the main window
999 <literal>GtkTreeView</literal> components, (Folder List and Message
1000 List). The only useful way to use this option is to set it to '0'
1001 when <literal>use_stripes_everywhere</literal> is set to '1'.
1002 </para>
1003 </listitem>
1004 </varlistentry>
1005 <varlistentry>
1006 <term><literal>utf8_instead_of_locale_for_broken_mail</literal></term>
1007 <listitem>
1008 <para>
1009 Use UTF-8 encoding for broken mails instead of current locale when
1010 set to '1'. Default value is '0'.
1011 </para>
1012 </listitem>
1013 </varlistentry>
1014 <varlistentry>
1015 <term><literal>imap_scan_tree_recurs_limit</literal></term>
1016 <listitem>
1017 <para>
1018 Recursion depth limit for IMAP's rebuild folder tree feature.
1019 </para>
1020 </listitem>
1021 </varlistentry>
1022 <varlistentry>
1023 <term><literal>warn_dnd</literal></term>
1024 <listitem>
1025 <para>
1026 Display a confirmation dialogue on drag 'n' drop of folders when set
1027 to '1' (default). Set to '0' to bypass this confirmation.
1028 </para>
1029 </listitem>
1030 </varlistentry>
1031 <varlistentry>
1032 <term><literal>warn_sending_many_recipients_num</literal></term>
1033 <listitem>
1034 <para>
1035 Display a confirmation dialogue when sending a message to a number
1036 of recipients larger than the value of this preference. Set to '0'
1037 to bypass this confirmation.
1038 </para>
1039 </listitem>
1040 </varlistentry>
1041 <varlistentry>
1042 <term><literal>zero_replacement_char</literal></term>
1043 <listitem>
1044 <para>
1045 Character to show in Folder List counter columns when a folder contains
1046 no messages. Default value is '0'.
1047 </para>
1048 </listitem>
1049 </varlistentry>
1050 </variablelist>
1051 </section>
1052 <section id="adv_autofaces">
1053 <title>Autofaces</title>
1054 <para>
1055 Claws Mail allows setting the Face and X-Face headers directly
1056 from files, either globally for all defined accounts
1057 or on a per-account basis. These files must be placed in the
1058 <filename>~/.claws-mail/autofaces/</filename> directory.
1059 </para>
1060 <para>
1061 If they exist, the global Face and/or X-Face headers for all
1062 accounts are taken from the <filename>face</filename> and/or
1063 <filename>xface</filename> files respectively. In a similar
1064 manner, Face and/or X-Face headers for a specific account can
1065 be provided by <filename>face.</filename><emphasis>accountname</emphasis>
1066 and/or <filename>xface.</filename><emphasis>accountname</emphasis>,
1067 where <emphasis>accountname</emphasis> is the name of the account you
1068 want this header to be associated with.
1069 </para>
1070 <para>
1071 If the name of the account contains characters which may be unsuitable
1072 for the underlying filesystem (including spaces) these are replaced by
1073 underscores (<quote>_</quote>) when searching for the autofaces of
1074 that account. For example, if your account is called
1075 <quote><My Mail></quote>, the name for the X-Face filename for
1076 that account would be
1077 <filename>~/.claws-mail/autofaces/xface._My_Mail_</filename>.
1078 Be aware that this feature doesn't check the content of the files,
1079 or for duplication of headers, (most mailers, including Claws
1080 Mail, will ignore duplicates and display the last one only).
1081 </para>
1082 </section>
1083 </section>