advanced.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080
  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="http://bogofilter.sourceforge.net/">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 Google using an external script</title>
  86. <variablelist>
  87. <varlistentry>
  88. <term>
  89. Menu name: <emphasis>Search/Google</emphasis>
  90. Command Line: <command>|/path/to/google_search.pl</command>
  91. </term>
  92. <listitem>
  93. <para>
  94. Searches Google for the currently selected text
  95. (<emphasis>|</emphasis>) using the external script <emphasis><ulink
  96. url="http://www.claws-mail.org/tools.php"
  97. >google_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="http://www.claws-mail.org/faq/"
  142. >http://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="http://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_unread</literal></term>
  584. <listitem>
  585. <para>
  586. Show unread messages in the message list of summary view using a
  587. bold font when set to '1' (default). '0' will use normal font.
  588. </para>
  589. </listitem>
  590. </varlistentry>
  591. <varlistentry>
  592. <term><literal>cache_max_mem_usage</literal></term>
  593. <listitem>
  594. <para>
  595. The maximum amount of memory to use to cache messages, in kB. It will
  596. try to keep the memory usage below this value, but it will always use
  597. the assigned amount of memory for speed gain. Default value is '4096'.
  598. </para>
  599. </listitem>
  600. </varlistentry>
  601. <varlistentry>
  602. <term><literal>cache_min_keep_time</literal></term>
  603. <listitem>
  604. <para>
  605. The minimum time in minutes to keep a folder cache in memory. Caches
  606. more recent than this time will not be freed, even if the memory usage
  607. is too high. You should probably set this value higher than your
  608. mail check interval. Otherwise the cache will always be freed between
  609. checks even if the folder is accessed on every check, which will cause
  610. much disk I/O. Default value is '15'.
  611. </para>
  612. </listitem>
  613. </varlistentry>
  614. <varlistentry>
  615. <term><literal>compose_no_markup</literal></term>
  616. <listitem>
  617. <para>
  618. Don't use bold and italic text in Compose dialogue's account selector
  619. if set to '1'. Default value is '0' (use markup).
  620. </para>
  621. </listitem>
  622. </varlistentry>
  623. <varlistentry>
  624. <term><literal>default_header_color</literal></term>
  625. <term><literal>default_header_bgcolor</literal></term>
  626. <listitem>
  627. <para>
  628. Foreground and background colors to use for the Compose window's header
  629. entry values. Default values are '#000000' (black) and '#f5f6be' (pale
  630. yellow), respectively.
  631. </para>
  632. </listitem>
  633. </varlistentry>
  634. <varlistentry>
  635. <term><literal>diff_added_color</literal></term>
  636. <term><literal>diff_deleted_color</literal></term>
  637. <term><literal>diff_hunk_color</literal></term>
  638. <listitem>
  639. <para>
  640. Colors to use when displaying attachments in unified diff format.
  641. Default values are '#008b8b' (dark cyan), '#6a5acd' (slate blue) and
  642. '#a52a2a' (red brown) respectively.
  643. </para>
  644. </listitem>
  645. </varlistentry>
  646. <varlistentry>
  647. <term><literal>emphasis_color</literal></term>
  648. <listitem>
  649. <para>
  650. The colour used for the X-Mailer line in Message View when its value
  651. is Claws Mail. Default value is '#0000CF' (medium blue).
  652. </para>
  653. </listitem>
  654. </varlistentry>
  655. <varlistentry>
  656. <term><literal>enable_avatars</literal></term>
  657. <listitem>
  658. <para>
  659. Enables capture and/or rendering of internal avatars (Face and
  660. also X-Face headers if built with compface support).
  661. '0' disables both, '1' enables capture only, '2' enables rendering
  662. only and '3' enables both. Default value is '3'.
  663. </para>
  664. <para>
  665. Note that external plugins already providing these features may
  666. disable partially or completely this to speed up process,
  667. regardless of the configured value.
  668. </para>
  669. </listitem>
  670. </varlistentry>
  671. <varlistentry>
  672. <term><literal>enable_hscrollbar</literal></term>
  673. <listitem>
  674. <para>
  675. Enable the horizontal scrollbar in the message list of Summary View
  676. if set to '1' (default). Set it to '0' to disable.
  677. </para>
  678. </listitem>
  679. </varlistentry>
  680. <varlistentry>
  681. <term><literal>enable_swap_from</literal></term>
  682. <listitem>
  683. <para>
  684. Display the sender's email address in the To column of the
  685. Sent folder instead of the recipient's when set to '1'.
  686. Default value is '0'.
  687. </para>
  688. </listitem>
  689. </varlistentry>
  690. <varlistentry>
  691. <term><literal>folder_search_wildcard</literal></term>
  692. <listitem>
  693. <para>
  694. The type-ahead function in the Select Folder window will match any
  695. part of the folder name ('1') or just the start of the folder
  696. name ('0'). Default value is '1'.
  697. </para>
  698. </listitem>
  699. </varlistentry>
  700. <varlistentry>
  701. <term><literal>folderview_vscrollbar_policy</literal></term>
  702. <listitem>
  703. <para>
  704. Specify the policy of vertical scrollbar of Folder List:
  705. '0' is always shown, '1' is automatic and '2' is always hidden.
  706. Default value is '0'.
  707. </para>
  708. </listitem>
  709. </varlistentry>
  710. <varlistentry>
  711. <term><literal>hide_timezone</literal></term>
  712. <listitem>
  713. <para>
  714. If enabled ('1') the timezone in date headers is set to the
  715. unknown timezone value, as specified in section 3 of the RFC
  716. 5322. Default value is '0'.
  717. </para>
  718. </listitem>
  719. </varlistentry>
  720. <varlistentry>
  721. <term><literal>hover_timeout</literal></term>
  722. <listitem>
  723. <para>
  724. Time in milliseconds that will cause a folder tree to expand
  725. when the mouse cursor is held over it during drag 'n' drop.
  726. Default value is '500'.
  727. </para>
  728. </listitem>
  729. </varlistentry>
  730. <varlistentry>
  731. <term><literal>live_dangerously</literal></term>
  732. <listitem>
  733. <para>
  734. Don't ask for confirmation before definitive deletion of emails when
  735. set to '1'. Default value is '0'.
  736. </para>
  737. </listitem>
  738. </varlistentry>
  739. <varlistentry>
  740. <term><literal>log_error_color</literal></term>
  741. <term><literal>log_in_color</literal></term>
  742. <term><literal>log_msg_color</literal></term>
  743. <term><literal>log_out_color</literal></term>
  744. <term><literal>log_warn_color</literal></term>
  745. <term><literal>log_status_ok_color</literal></term>
  746. <term><literal>log_status_nok_color</literal></term>
  747. <term><literal>log_status_skip_color</literal></term>
  748. <listitem>
  749. <para>
  750. The colours used in the log window. Default values are: '#af0000'
  751. (dark red), '#000000' (black), '#00af00' (dark lime green),
  752. '#0000ef' (blue), '#af0000' (dark red), '#00af00' (dark lime green),
  753. '#0000af' (dark blue) and '#aa00aa' (dark magenta) respectively.
  754. </para>
  755. </listitem>
  756. </varlistentry>
  757. <varlistentry>
  758. <term><literal>master_passphrase_pbkdf2_rounds</literal></term>
  759. <listitem>
  760. <para>
  761. Number of rounds (or iterations) to use in PBKDF2 function when
  762. computing next master passphrase key derivation. Currently stored master
  763. passphrase KD is not affected by changing this preference.
  764. Default value is '50000'.
  765. </para>
  766. </listitem>
  767. </varlistentry>
  768. <varlistentry>
  769. <term><literal>msgview_date_format</literal></term>
  770. <listitem>
  771. <para>
  772. '0' or '1'. Use the same user-defined date format in the Message
  773. View as is used in the Message List. Default is '0', turned off.
  774. </para>
  775. </listitem>
  776. </varlistentry>
  777. <varlistentry>
  778. <term><literal>next_on_delete</literal></term>
  779. <listitem>
  780. <para>
  781. '0' or '1'. Controls the message selection after deleting, moving, or
  782. trashing a message. Default is '0', select previous message.
  783. </para>
  784. </listitem>
  785. </varlistentry>
  786. <varlistentry>
  787. <term><literal>outgoing_fallback_to_ascii</literal></term>
  788. <listitem>
  789. <para>
  790. '0' or '1'. The outgoing encoding of a message will use 7bit US-ASCII
  791. whenever it is suitable for the message content, ignoring the
  792. <quote>Outgoing encoding</quote> option unless it is necessary. Turning
  793. this option off forces the user-defined encoding to be used, regardless
  794. of message content. Default is '1', turned on.
  795. </para>
  796. </listitem>
  797. </varlistentry>
  798. <varlistentry>
  799. <term><literal>primary_paste_unselects</literal></term>
  800. <listitem>
  801. <para>
  802. '0' or '1'. Causes the primary buffer to be cleared and the insertion
  803. point to be repositioned when the middle mouse button is used
  804. for pasting text. Default is '0', turned off.
  805. </para>
  806. </listitem>
  807. </varlistentry>
  808. <varlistentry>
  809. <term><literal>qs_active_color</literal></term>
  810. <term><literal>qs_active_bgcolor</literal></term>
  811. <term><literal>qs_error_color</literal></term>
  812. <term><literal>qs_error_bgcolor</literal></term>
  813. <listitem>
  814. <para>
  815. Foreground and background colors to use in the QuickSearch field when
  816. the search is active and when there is a syntax error.
  817. Default values are '#000000' (black), '#f5f6be' (pale yellow), '#000000'
  818. (black), and '#ff7070' (pale red), respectively.
  819. </para>
  820. </listitem>
  821. </varlistentry>
  822. <varlistentry>
  823. <term><literal>respect_flowed_format</literal></term>
  824. <listitem>
  825. <para>
  826. '0' or '1'. Respect <literal>format=flowed</literal> on
  827. <literal>text/plain</literal> message parts. This
  828. will cause some mails to have long lines, but will fix some URLs
  829. that would otherwise be wrapped. Default is '0', turned off.
  830. </para>
  831. </listitem>
  832. </varlistentry>
  833. <varlistentry>
  834. <term><literal>rewrite_first_from</literal></term>
  835. <listitem>
  836. <para>
  837. '0' or '1'. This works around a limitation of some servers with
  838. 'overly-liberal parsers'. When this is turned on and the Content-
  839. Transfer-Encoding is set to 8bit or 7bit, in a message body starting with
  840. 'From ' the 'From ' will become '=46rom ' and the Content-Transfer-Encoding
  841. will be changed to Quoted-Printable. When it is turned off no such modification
  842. will be made but it is very likely that an MTA will convert the 'From ' to
  843. '>From '. See RFC 4155 for further details. Default value is '1', turned on.
  844. </para>
  845. </listitem>
  846. </varlistentry>
  847. <varlistentry>
  848. <term><literal>save_parts_readwrite</literal></term>
  849. <listitem>
  850. <para>
  851. If set to '1' saves temporary files when opening attachments with
  852. write bit set. Default value is '0', temporary files are read only.
  853. </para>
  854. </listitem>
  855. </varlistentry>
  856. <varlistentry>
  857. <term><literal>show_compose_margin</literal></term>
  858. <listitem>
  859. <para>
  860. '0' or '1'. Adds margins to the message text area in the Compose window.
  861. Default is '0', turned off.
  862. </para>
  863. </listitem>
  864. </varlistentry>
  865. <varlistentry>
  866. <term><literal>show_inline_attachments</literal></term>
  867. <listitem>
  868. <para>
  869. '0' or '1'. Show inline attachments in MimeView.
  870. Default is '1', turned on.
  871. </para>
  872. </listitem>
  873. </varlistentry>
  874. <varlistentry>
  875. <term><literal>skip_ssl_cert_check</literal></term>
  876. <listitem>
  877. <para>
  878. Disables the verification of SSL certificates when set to '1'.
  879. Default value is '0'.
  880. </para>
  881. </listitem>
  882. </varlistentry>
  883. <varlistentry>
  884. <term><literal>statusbar_update_step</literal></term>
  885. <listitem>
  886. <para>
  887. Update stepping in progress bars. Default value is '10'.
  888. </para>
  889. </listitem>
  890. </varlistentry>
  891. <varlistentry>
  892. <term><literal>stripes_color_offset</literal></term>
  893. <listitem>
  894. <para>
  895. Specify the value to use when creating alternately coloured lines in
  896. <literal>GtkTreeView</literal> components. The smaller the value, the
  897. less visible the difference in the alternating colours of the lines.
  898. Default value is '4000'.
  899. </para>
  900. </listitem>
  901. </varlistentry>
  902. <varlistentry>
  903. <term><literal>summary_from_show</literal></term>
  904. <listitem>
  905. <para>
  906. Controls the data displayed in the From column in the Message List.
  907. Default value '0' displays name, '1' displays address and '2' displays
  908. both name and address.
  909. </para>
  910. </listitem>
  911. </varlistentry>
  912. <varlistentry>
  913. <term><literal>tags_color</literal></term>
  914. <term><literal>tags_bgcolor</literal></term>
  915. <listitem>
  916. <para>
  917. Foreground and background colors to use when displaying tags.
  918. Default values are '#000000' (black) and '#f5f6be' (pale yellow),
  919. respectively.
  920. </para>
  921. </listitem>
  922. </varlistentry>
  923. <varlistentry>
  924. <term><literal>textview_cursor_visible</literal></term>
  925. <listitem>
  926. <para>
  927. Display the cursor in the message view when set to '1'.
  928. Default value is '0'.
  929. </para>
  930. </listitem>
  931. </varlistentry>
  932. <varlistentry>
  933. <term><literal>thread_by_subject_max_age</literal></term>
  934. <listitem>
  935. <para>
  936. Number of days to include a message in a thread when using
  937. <quote>Thread using subject in addition to standard headers</quote>.
  938. Default value is '10'.
  939. </para>
  940. </listitem>
  941. </varlistentry>
  942. <varlistentry>
  943. <term><literal>toolbar_detachable</literal></term>
  944. <listitem>
  945. <para>
  946. Show handles in the toolbars when set to '1'. Default value is '0'.
  947. </para>
  948. </listitem>
  949. </varlistentry>
  950. <varlistentry>
  951. <term><literal>type_any_header</literal></term>
  952. <listitem>
  953. <para>
  954. Allows to type any header on the compose window header entries
  955. when set to '1'. By default ('0') only the entries available
  956. from the combobox can be selected.
  957. </para>
  958. </listitem>
  959. </varlistentry>
  960. <varlistentry>
  961. <term><literal>two_line_vertical</literal></term>
  962. <listitem>
  963. <para>
  964. Spread message list information over two lines when using the
  965. three column layout when set to '1' (default). Set it to '0'
  966. to use only one line.
  967. </para>
  968. </listitem>
  969. </varlistentry>
  970. <varlistentry>
  971. <term><literal>unsafe_ssl_certs</literal></term>
  972. <listitem>
  973. <para>
  974. Allows Claws Mail to remember multiple SSL certificates for a given
  975. server/port when set to '1'. This is disabled by default ('0').
  976. </para>
  977. </listitem>
  978. </varlistentry>
  979. <varlistentry>
  980. <term><literal>use_networkmanager</literal></term>
  981. <listitem>
  982. <para>
  983. Use NetworkManager to switch offline automatically. This is enabled
  984. by default ('1'). Set it to '0' to ignore NetworkManager.
  985. </para>
  986. </listitem>
  987. </varlistentry>
  988. <varlistentry>
  989. <term><literal>use_stripes_everywhere</literal></term>
  990. <listitem>
  991. <para>
  992. Enable alternately coloured lines in <literal>GtkTreeView</literal>
  993. components when set to '1' (default). Set it to '0' to disable them.
  994. </para>
  995. </listitem>
  996. </varlistentry>
  997. <varlistentry>
  998. <term><literal>use_stripes_in_summaries</literal></term>
  999. <listitem>
  1000. <para>
  1001. Enable alternately coloured lines in the main window
  1002. <literal>GtkTreeView</literal> components, (Folder List and Message
  1003. List). The only useful way to use this option is to set it to '0'
  1004. when <literal>use_stripes_everywhere</literal> is set to '1'.
  1005. </para>
  1006. </listitem>
  1007. </varlistentry>
  1008. <varlistentry>
  1009. <term><literal>utf8_instead_of_locale_for_broken_mail</literal></term>
  1010. <listitem>
  1011. <para>
  1012. Use UTF-8 encoding for broken mails instead of current locale when
  1013. set to '1'. Default value is '0'.
  1014. </para>
  1015. </listitem>
  1016. </varlistentry>
  1017. <varlistentry>
  1018. <term><literal>warn_dnd</literal></term>
  1019. <listitem>
  1020. <para>
  1021. Display a confirmation dialogue on drag 'n' drop of folders when set
  1022. to '1' (default). Set to '0' to bypass this confirmation.
  1023. </para>
  1024. </listitem>
  1025. </varlistentry>
  1026. <varlistentry>
  1027. <term><literal>warn_sending_many_recipients_num</literal></term>
  1028. <listitem>
  1029. <para>
  1030. Display a confirmation dialogue when sending a message to a number
  1031. of recipients larger than the value of this preference. Set to '0'
  1032. to bypass this confirmation.
  1033. </para>
  1034. </listitem>
  1035. </varlistentry>
  1036. <varlistentry>
  1037. <term><literal>zero_replacement_char</literal></term>
  1038. <listitem>
  1039. <para>
  1040. Character to show in Folder List counter columns when a folder contains
  1041. no messages. Default value is '0'.
  1042. </para>
  1043. </listitem>
  1044. </varlistentry>
  1045. </variablelist>
  1046. </section>
  1047. <section id="adv_autofaces">
  1048. <title>Autofaces</title>
  1049. <para>
  1050. Claws Mail allows setting the Face and X-Face headers directly
  1051. from files, either globally for all defined accounts
  1052. or on a per-account basis. These files must be placed in the
  1053. <filename>~/.claws-mail/autofaces/</filename> directory.
  1054. </para>
  1055. <para>
  1056. If they exist, the global Face and/or X-Face headers for all
  1057. accounts are taken from the <filename>face</filename> and/or
  1058. <filename>xface</filename> files respectively. In a similar
  1059. manner, Face and/or X-Face headers for a specific account can
  1060. be provided by <filename>face.</filename><emphasis>accountname</emphasis>
  1061. and/or <filename>xface.</filename><emphasis>accountname</emphasis>,
  1062. where <emphasis>accountname</emphasis> is the name of the account you
  1063. want this header to be associated with.
  1064. </para>
  1065. <para>
  1066. If the name of the account contains characters which may be unsuitable
  1067. for the underlying filesystem (including spaces) these are replaced by
  1068. underscores (<quote>_</quote>) when searching for the autofaces of
  1069. that account. For example, if your account is called
  1070. <quote>&lt;My Mail&gt;</quote>, the name for the X-Face filename for
  1071. that account would be
  1072. <filename>~/.claws-mail/autofaces/xface._My_Mail_</filename>.
  1073. Be aware that this feature doesn't check the content of the files,
  1074. or for duplication of headers, (most mailers, including Claws
  1075. Mail, will ignore duplicates and display the last one only).
  1076. </para>
  1077. </section>
  1078. </section>