TDE personal information management applications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

using-kmail.docbook 93KB

  1. <chapter id="using-kmail">
  2. <chapterinfo>
  3. <authorgroup>
  4. <author>
  5. <firstname>Daniel</firstname>
  6. <surname>Naber</surname>
  7. <affiliation><address>
  8. <email></email>
  9. </address></affiliation>
  10. </author>
  12. </authorgroup>
  13. <date>2004-09-24</date>
  14. <releaseinfo>1.7.50</releaseinfo>
  15. </chapterinfo>
  16. <title>Using &kmail;</title>
  17. <sect1 id="the-mail-reader-window">
  18. <title>The Main Window</title>
  19. <para>The main window is the window that appears
  20. when &kmail; is started. It is by default divided into three panes:</para>
  21. <variablelist>
  22. <varlistentry>
  23. <term>Folder list (on the left)</term>
  24. <listitem>
  25. <para>This pane contains the list of your message folders (other email programs
  26. may call them mailboxes). To select a folder, simply click on
  27. it. The messages contained in the folder will now appear in the Headers
  28. pane. The folder list can be displayed in both a short view, which takes up only
  29. a small portion of the left side of the screen, and a long view, which takes up the
  30. entire left side of the screen but is able to show more mailboxes. You can toggle
  31. between these two views under <guilabel>Appearance</guilabel>/<guilabel>Layout</guilabel>
  32. in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  33. &kmail;...</guimenuitem></menuchoice> dialog. Also see the <link
  34. linkend="folders">Folders Section</link> for more information about how to use
  35. folders.</para>
  36. </listitem>
  37. </varlistentry>
  38. <varlistentry>
  39. <term>Message list (in the upper right by default)</term>
  40. <listitem>
  41. <para>This pane lists header information (message Status Flags, Sender, Subject,
  42. Date, and other optional columns like Size, Attachment Flag, Important Flag, etc.)
  43. for the messages in the currently selected folder. Clicking on a header
  44. will select that message and display it in the Message pane; you can also select
  45. more than one message by holding down the &Ctrl; key when clicking on messages.
  46. You may sort the messages by clicking on the column that you wish to
  47. sort; if you click on the same column more than once, sort order will toggle
  48. between ascending/descending and some alternative sorting criteria will become
  49. available (like sorting by Status when you click on the header of the Subject column).
  50. Clicking the <mousebutton>right</mousebutton> mousebutton on the list header shows a popup menu,
  51. which allows to show or hide several columns in the list.
  52. </para>
  53. </listitem>
  54. </varlistentry>
  55. <varlistentry>
  56. <term>Message preview pane (in the lower right by default)</term>
  57. <listitem>
  58. <para>This pane displays the currently selected message. Attachments appear
  59. at the bottom of the message, either as icons or embedded in the message,
  60. depending on <menuchoice><guimenu>View</guimenu>
  61. <guimenuitem>Attachments</guimenuitem></menuchoice>. For complex messages
  62. the structure of the message is shown in the message structure viewer below
  63. the preview pane. The placement of the preview pane as well as the placement
  64. of the structure viewer can be changed under <guilabel>Appearance</guilabel>/<guilabel>Layout</guilabel>
  65. in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  66. &kmail;...</guimenuitem></menuchoice> dialog. Moreover, you can disable the
  67. preview pane and you can choose when the message structure viewer should be
  68. shown.
  69. You can scroll through the message page-by-page
  70. using the <keycap>Page Up</keycap> and <keycap>Page down</keycap> keys, or
  71. line-by-line using the <keycap>up arrow</keycap> and <keycap>down arrow</keycap>
  72. keys; you can also use <link linkend="keyboard-shortcuts">key shortcuts</link> to skip through
  73. your messages without having to use the mouse.</para>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry>
  77. <term>Font type and font size</term>
  78. <listitem>
  79. <para>Font type and font size buttons in main toolbar in the message reader window ( window that appears when an message is double clicked or enter is pressed on the message ) will change the font type or font size of the whole text of the email message in concern. This property is transient ( per email message ) and will be lost when the reader window is closed.</para>
  80. </listitem>
  81. </varlistentry>
  82. <varlistentry>
  83. <term>Delete Attachment</term>
  84. <listitem>
  85. <para>Right click on the attachment either in the message itself or in the message structure window, choose "Delete Attachment" to delete the attachement. Please note that deleting an attachment can invalidate any digital signature in the message.</para>
  86. </listitem>
  87. </varlistentry>
  88. </variablelist>
  89. </sect1>
  90. <sect1 id="keyboard-shortcuts">
  91. <title>Keyboard Shortcuts</title>
  92. <para>The following keyboard shortcuts are supported in the main window:</para>
  93. <informaltable>
  94. <tgroup cols="2">
  95. <thead>
  96. <row>
  97. <entry>Keyboard Shortcut</entry>
  98. <entry>Action</entry>
  99. </row>
  100. </thead>
  101. <tbody>
  102. <row>
  103. <entry><keycap>Space</keycap></entry>
  104. <entry>Scroll down in the current message or go to the next unread message if you are already
  105. at the bottom.</entry>
  106. </row>
  107. <row>
  108. <entry><keycap>Right Arrow</keycap> or <keycap>N</keycap></entry>
  109. <entry>Go to the next message in the current folder.</entry>
  110. </row>
  111. <row>
  112. <entry><keycap>Left Arrow</keycap> key or <keycap>P</keycap></entry>
  113. <entry>Go to the previous message in the current folder.</entry>
  114. </row>
  115. <row>
  116. <entry><keycap>+</keycap></entry>
  117. <entry>Go to the next unread message in the current folder.</entry>
  118. </row>
  119. <row>
  120. <entry><keycap>-</keycap></entry>
  121. <entry>Go to the previous unread message in the current folder.</entry>
  122. </row>
  123. <row>
  124. <entry><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></entry>
  125. <entry>Go to the next folder with unread messages.</entry>
  126. </row>
  127. <row>
  128. <entry><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></entry>
  129. <entry>Go to the previous folder with unread messages.</entry>
  130. </row>
  131. <row>
  132. <entry><keycombo action="simul">&Ctrl;<keycap>Up Arrow</keycap></keycombo></entry>
  133. <entry>Go to the next folder in the folder list (if the folder list has focus.)</entry>
  134. </row>
  135. <row>
  136. <entry><keycombo action="simul">&Ctrl;<keycap>Down Arrow</keycap></keycombo></entry>
  137. <entry>Go to the previous folder in the folder list (if the folder list has focus.)</entry>
  138. </row>
  139. <row>
  140. <entry><keycombo action="simul">&Ctrl;<keycap>Left Arrow</keycap></keycombo></entry>
  141. <entry>Walk upwards in the list of folders. Use
  142. <keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> to actually
  143. enter the folder.</entry>
  144. <!-- TODO: or wait for timeout so the folder is selected? -->
  145. </row>
  146. <row>
  147. <entry><keycombo action="simul">&Ctrl;<keycap>Right Arrow</keycap></keycombo></entry>
  148. <entry>Walk downwards in the list of folders. Use
  149. <keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> to actually
  150. enter the folder.</entry>
  151. </row>
  152. <row>
  153. <entry><keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo></entry>
  154. <entry>Enter the folder that has focus, &ie; the folder that you navigated
  155. to using <keycombo action="simul">&Ctrl;<keycap>Left Arrow</keycap></keycombo> or
  156. <keycombo action="simul">&Ctrl;<keycap>Right Arrow</keycap></keycombo>.</entry>
  157. </row>
  158. <row>
  159. <entry><keycombo action="simul">&Shift;<keycap>Left Arrow</keycap></keycombo> and
  160. <keycombo action="simul">&Shift;<keycap>Right Arrow</keycap></keycombo></entry>
  161. <entry>Select messages in the header pane, starting with the current message.</entry>
  162. </row>
  163. </tbody>
  164. </tgroup>
  165. </informaltable>
  166. <para>For more keyboard shortcuts have a look at the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  167. Shortcuts...</guimenuitem></menuchoice> dialog.</para>
  168. </sect1>
  169. <sect1 id="the-composer-window">
  170. <title>The Composer Window</title>
  171. <para>The composer window is used to write new messages;
  172. it can be invoked via <menuchoice><guimenu>Message</guimenu>
  173. <guimenuitem>New Message...</guimenuitem></menuchoice>
  174. menu or from the <guiicon>New Message</guiicon> icon on the main
  175. window.</para>
  176. <sect2 id="composing-a-message">
  177. <title>Composing a Message</title>
  178. <para>To write your message, fill in the appropriate fields in the
  179. composer window. Use the <guimenu>View</guimenu> menu
  180. to select which header fields are displayed. The <guimenuitem>Identity</guimenuitem>
  181. field offers a <guibutton>Sticky</guibutton> option; if it is checked,
  182. the current identity will become the default identity when you open
  183. a new composer next time.</para>
  184. <para>There are a variety of shortcuts to help
  185. you with writing your messages. The <guibutton>...</guibutton> buttons next to
  186. the <guilabel>To:</guilabel>, <guilabel>CC:</guilabel>, and
  187. <guilabel>BCC:</guilabel> fields will call up the address book so that you can
  188. select addresses from there.</para>
  189. <para>When you start typing an address in the
  190. <guilabel>To:</guilabel>/<guilabel>CC:</guilabel>/<guilabel>BCC:</guilabel>
  191. fields, a popup will appear that offers matching addresses that have been used recently
  192. and matching addresses from your address book. If you use multiple addressbooks, you can
  193. use the TAB key to select the first entry of the next addressbook in the list.
  194. If you do not like the automatic popup you can disable it by clicking with the &RMB; on the field and choosing
  195. a different completion mode.</para>
  196. <para>Whenever you want to add more than one
  197. recipient in one of the fields, use a comma to separate each address
  198. from the next one.
  199. <!-- fixme: there's now a setting for this: -->
  200. You may need to specify fully qualified addresses
  201. (&ie; <userinput></userinput>) even for local
  202. users, depending on your system configuration.</para>
  203. <para>When you are finished with your
  204. message, click the <guiicon>Send Now</guiicon> icon (the envelope) to send
  205. the message now, or click the <guiicon>Send Later</guiicon> icon to put
  206. the message in the outbox. If your message is not finished yet, select
  207. <menuchoice><guimenu>Message</guimenu><guimenuitem>Save in Drafts
  208. Folder</guimenuitem></menuchoice>.
  209. </para></sect2>
  210. <sect2 id="encrypt-sign">
  211. <title>Signing and Encrypting Messages</title>
  212. <para>
  213. If you want to send an <link
  214. linkend="pgp-encrypt-your-messages">encrypted</link>
  215. or <link linkend="pgp-sign-your-messages">digitally signed</link> message, select the
  216. <guiicon>Sign Message</guiicon> or <guiicon>Encrypt
  217. Message</guiicon> icons in the toolbar. Moreover you can select the format that should be used to sign and/or encrypt the message. Depending on the
  218. installed encryption programs you can choose between:
  219. </para>
  220. <variablelist id="cryptographic-message-formats">
  221. <varlistentry>
  222. <term><guilabel>Any</guilabel></term>
  223. <listitem>
  224. <para>&kmail; will use a format which is understood by all recipients of the
  225. message. The preferred format of the recipients can be specified in the
  226. KDE Address Book.</para></listitem>
  227. </varlistentry>
  228. <varlistentry>
  229. <term><guilabel>Inline OpenPGP (deprecated)</guilabel></term>
  230. <listitem>
  231. <para>This format is outdated. If you use this format then only the
  232. message text will be signed and/or encrypted. <emphasis>Attachments will
  233. neither be signed nor encrypted.</emphasis> HTML messages cannot be signed
  234. with this format. You should only use this format
  235. if necessary, &ie; if you send messages to users of email clients that cannot
  236. handle the more advanced formats.</para></listitem>
  237. </varlistentry>
  238. <varlistentry>
  239. <term><guilabel>PGP/MIME</guilabel></term>
  240. <listitem>
  241. <para>This format is the successor of the inline OpenPGP format. If you
  242. use this format then the message text and all attachments will be signed
  243. and/or encrypted (at least by default). This is the recommended format if you
  244. use OpenPGP.</para></listitem>
  245. </varlistentry>
  246. <varlistentry>
  247. <term><guilabel>S/MIME</guilabel></term>
  248. <listitem>
  249. <para>This format is an alternative format to PGP/MIME. If you
  250. use this format then the message text and all attachments will be signed
  251. and/or encrypted (at least by default). This format is mostly used by
  252. corporations.</para></listitem>
  253. </varlistentry>
  254. <varlistentry>
  255. <term><guilabel>S/MIME opaque</guilabel></term>
  256. <listitem>
  257. <para>This format is a variant of the S/MIME format. It should only be
  258. used if necessary.</para></listitem>
  259. </varlistentry>
  260. </variablelist>
  261. </sect2>
  262. <sect2 id="html-mails">
  263. <title>Creating HTML Messages</title>
  264. <para>Note that HTML messages are often regarded as an annoyance; therefore,
  265. you should avoid sending HTML messages if possible. Particularly, you should never
  266. send HTML messages to a mailing list unless HTML messages are explicitly
  267. allowed.</para>
  268. <para>In order to be able to create HTML messages you first have to enable
  269. the markup tools. To do this enable <guimenuitem>Formatting (HTML)</guimenuitem> in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu.
  270. A toolbar with several tools to
  271. format the message will appear. Via the drop down box you can select between
  272. standard text and six different types of lists (three bulleted lists with
  273. different symbols and three numbered lists with different numbering).
  274. Moreover, you can select the font family, the font size, the font style (bold,
  275. italic, underlined) and the text color. Last but not least, you can select
  276. the alignment of the text (left aligned, centered, right aligned).</para>
  277. <para>Creating tables and embedding images is currently not possible.</para>
  278. </sect2>
  279. <sect2 id="attachments">
  280. <title>Adding Attachments</title>
  281. <para>You can attach files to your message by using one of the methods
  282. below:</para>
  283. <itemizedlist>
  284. <listitem>
  285. <para>Click the <guiicon>Attach File</guiicon> (paper clip) icon and select the file you wish
  286. to attach;</para>
  287. </listitem>
  288. <listitem>
  289. <para>Drag a file from the desktop or another folder into the
  290. composer window;</para>
  291. </listitem>
  292. <listitem>
  293. <para>Drag a message from &kmail;'s message list into the composer
  294. window -- that message will then be attached;</para>
  295. </listitem>
  296. <listitem>
  297. <para>Select one of the options in the
  298. <menuchoice><guimenu>Attach</guimenu></menuchoice> menu.</para>
  299. </listitem>
  300. </itemizedlist>
  301. <para>Once a file is attached to your message, it appears in the attachments
  302. pane at the bottom of the composer window. You can use the
  303. &RMB; on each attachment to <guimenuitem>View</guimenuitem>,
  304. <guimenuitem>Save</guimenuitem> or <guimenuitem>Remove</guimenuitem>
  305. the attachment.</para>
  306. <para>Use the <guimenuitem>Properties</guimenuitem> item to
  307. open the <guilabel>Message Part Properties</guilabel> dialog.
  308. The first field contains the attachment's &MIME; type. Just like the <guilabel>Name</guilabel>
  309. field, it should be automatically filled with an appropriate value. Sometimes the
  310. &MIME; type value may be wrong. You can then type in any &MIME; type or
  311. choose from the list of common &MIME; types. You can also select an encoding
  312. method for your file from the list of encoding options (normally, the default
  313. value works fine). Check the <guilabel>Suggest automatic display</guilabel> option
  314. if you want to suggest to the recipient the automatic (inline) display of this attachment. Whether this works or not depends on the recipient's email client
  315. and on his settings.</para>
  316. <para>You can also attach public keys to the message by using the appropriate options in the
  317. <menuchoice><guimenu>Attach</guimenu></menuchoice> menu. <application>PGP</application>
  318. key attachments are handled like file attachments.</para>
  319. </sect2>
  320. <sect2 id="checking-the-spelling-of-your-message">
  321. <title>Checking the Spelling of your Message</title>
  322. <para>&kmail; will automatically check the spelling of your message (in
  323. HTML mode this currently does not work)
  324. and display unknown words using red color. If there are too many
  325. unknown words &kmail; will disable its checking. To select the language
  326. used for checking, select <menuchoice><guimenu>View</guimenu>
  327. <guimenuitem>Dictionary</guimenuitem></menuchoice>. You can disable
  328. automatic spellchecking in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu.</para>
  329. <para>To check the spelling of your message using a dialog, select
  330. <menuchoice><guimenu>Tools</guimenu>
  331. <guimenuitem>Spelling...</guimenuitem></menuchoice>. &kmail; uses
  332. <ulink url="/kspell/">&kspell;</ulink> to
  333. check spelling, which is the &kde; frontend to the
  334. <application>ispell</application> or <application>aspell</application> spelling
  335. checker. Note that you may first need to configure the spellchecker using
  336. <menuchoice><guimenu>Settings</guimenu>
  337. <guimenuitem>Spellchecker...</guimenuitem></menuchoice>.</para>
  338. </sect2>
  339. <sect2 id="setup-text-snippets">
  340. <title>Setting Up the Text Snippets Tool</title>
  341. <para>
  342. When editing in the composer window you can store often used parts of text as snippets. To configure the capabilities of the mail snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Snippets</guimenuitem> </menuchoice> from the menubar. A new panel will appear on the left side of the composer.
  343. </para>
  344. <para>To add a new snippet to Snippet Panel, right click on panel, click on <menuchoice><guimenu>Add Snippet</guimenu></menuchoice> in the context menu. A snippet editor dialog will appear, in which new text can be added and the snippet can be given a name. Also a <guilabel>Shortcut</guilabel> can be associated with the snippet.
  345. Snippets can be grouped together as well by creating groups and adding snippets to particular group. If you want to view the stored text in a tooltip window whenever you keep the mouse cursor over the title of that snippet.
  346. </para>
  347. <para>The <guilabel>Snippets</guilabel> tool allows for a variable text in predefined places any time you insert a snippet into a file. To accomplish this <guilabel>Snippets</guilabel> provides its own variables' mechanism. You can set up its behaviour in the snippet text itself by using separators ( $ ) that enclose the variable names. For example : $variablename$, $invoicenumber$, $weekno$.
  348. </para>
  349. <para>
  350. The variable separator can be changed to some other character by changing "snippetDelimiter" in [SnippetPart] section. The Text Snippet configuration file can be found here $KDEHOME/share/config/kmailsnippetrc .
  351. <programlisting>
  352. snippetDelimiter=$
  353. </programlisting>
  354. </para>
  355. </sect2>
  356. </sect1>
  357. <sect1 id="folders">
  358. <title>Message Folders</title>
  359. <para>Message Folders are used to organize your email messages. By default,
  360. if you have no existing message folders, messages are stored in the folder
  361. <filename
  362. class="directory">$<envar>KDEHOME</envar>/share/apps/kmail/</filename>. If
  363. you have existing message folders in <filename
  364. class="directory">~/Mail</filename>, these will be used instead. When you
  365. first start &kmail; the <guilabel>inbox</guilabel>,
  366. <guilabel>outbox</guilabel>, <guilabel>sent-mail</guilabel>,
  367. <guilabel>trash</guilabel> and <guilabel>drafts</guilabel> folders are
  368. created. These folders each have special functions:</para>
  369. <variablelist>
  370. <varlistentry>
  371. <term><guilabel>inbox:</guilabel></term>
  372. <listitem>
  373. <para>Where &kmail; by default puts your new messages when you ask it to check your
  374. mail. </para>
  375. </listitem>
  376. </varlistentry>
  377. <varlistentry>
  378. <term><guilabel>outbox:</guilabel></term>
  379. <listitem>
  380. <para>Where messages are put while they are waiting to be delivered. Note that
  381. you should not drag and drop messages here to send them, use the <guiicon>Send</guiicon>
  382. icon in the composer window instead.<!-- fixme 3.2: has this been 'fixed'? --></para>
  383. </listitem>
  384. </varlistentry>
  385. <varlistentry>
  386. <term><guilabel>sent-mail:</guilabel></term>
  387. <listitem>
  388. <para>By default copies of all messages that you have sent are put into this folder.</para>
  389. </listitem>
  390. </varlistentry>
  391. <varlistentry>
  392. <term><guilabel>trash:</guilabel></term>
  393. <listitem>
  394. <para>By default all messages that you have moved to trash are moved into this folder.</para>
  395. </listitem>
  396. </varlistentry>
  397. <varlistentry>
  398. <term><guilabel>drafts:</guilabel></term>
  399. <listitem>
  400. <para>Contains messages you started to edit but then saved to this
  401. folder instead of sending them.</para>
  402. </listitem>
  403. </varlistentry>
  404. </variablelist>
  405. <para>You may find that the standard folders are fine for your
  406. needs; eventually, though, you will probably need folders to help you organize
  407. your messages. To create a new folder, select
  408. <menuchoice><guimenu>Folder</guimenu><guimenuitem>New Folder...</guimenuitem></menuchoice>:
  409. the <link linkend="folders-properties-window">folder properties</link> dialog
  410. will then prompt you for the necessary information. If you ever need to change
  411. the settings for a folder, select the folder you wish to modify in the Folders pane and select
  412. <menuchoice><guimenu>Folder</guimenu><guimenuitem>Properties</guimenuitem>
  413. </menuchoice>.</para>
  414. <para>To move messages from one folder into another, select the message(s) you
  415. want to move and press the <keycap>M</keycap> key or select
  416. <menuchoice><guimenu>Message</guimenu><guimenuitem>Move
  417. To</guimenuitem></menuchoice>. A list of folders will appear; select the folder
  418. from the list that you want to move the messages to. Messages can also be moved
  419. by dragging them from the Message list to a folder in the Folder list.</para>
  420. <para>If you want to clear all of the messages out of a folder choose
  421. <menuchoice><guimenu>Folder</guimenu><guimenuitem>Move All Messages to
  422. Trash</guimenuitem></menuchoice>. You can use
  423. <menuchoice><guimenu>Folder</guimenu><guimenuitem>Delete Folder</guimenuitem></menuchoice>
  424. to remove a folder and all its messages and subfolders.</para>
  425. <para>Folders can be copied or moved by using either drag and drop or the <menuchoice>
  426. <guimenuitem>Copy Folder</guimenuitem></menuchoice> and <menuchoice>
  427. <guimenuitem>Move Folder</guimenuitem></menuchoice> context menu entries. Note that you cannot
  428. move the above listed special folders.
  429. </para>
  430. <sect2 id="folders-properties-window">
  431. <title>Folder Properties</title>
  432. <para>The folder's <guilabel>Properties</guilabel> dialog lets you rename and move
  433. a folder and specify all of its properties. Note that most properties
  434. are only available for your own folders and not for default folder like
  435. <guilabel>inbox</guilabel> &etc;. Default folders also cannot be moved
  436. or renamed.</para>
  437. <sect3 id="folders-properties-general">
  438. <title>General</title>
  439. <para>Rename a folder by changing the entry in the <guilabel>Name:</guilabel> field.</para>
  440. <para>You can make a folder a subfolder of another folder by choosing a new parent
  441. folder using the <guilabel>Belongs to</guilabel> selection. </para>
  442. <para>The <guilabel>Folder Icons</guilabel> section lets you choose
  443. icons that are different from the default ones in the folder list.</para>
  444. <para>See the <link linkend="folders-format">Folder Format</link> section
  445. for information about the <guilabel>Mailbox format.</guilabel></para>
  446. <para>With the <guilabel>Identity</guilabel> section you can set the default
  447. identity that should be used for new messages if this folder is selected.
  448. Replies to messages that were sent directly
  449. to you will still default to the message's <quote>To</quote> address if an
  450. according identity is found.</para>
  451. <para>With <guilabel>Show Sender/Receiver</guilabel> you can set the
  452. visible columns in the header pane. This is useful if you use a
  453. folder to save your own sent messages.</para>
  454. <para>Check <guilabel>Ignore new mail in this folder</guilabel> if you do not
  455. want to be informed about new mail that arrives in this folder. This is for
  456. example useful for the folder where you move all detected spam messages to.</para>
  457. <para>Check <guilabel>Keep replies in this folder</guilabel> if you want
  458. replies to messages in this folder to be filed also into this folder rather
  459. than into a special sent-mail folder.</para>
  460. <para>For calendar folders you can select who should get reminders for the contained
  461. events by using the <guilabel>Generate free/busy and activate alarms for</guilabel>
  462. choice box.</para>
  463. <para>In case you don't want to receive reminders for folders shared by someone else,
  464. you can block them locally by activating the <guilabel>Block alarms locally</guilabel>
  465. checkbox.</para>
  466. </sect3>
  467. <sect3 id="folders-properties-expiry">
  468. <title>Old Message Expiry</title>
  469. <para>Here you can select what should happen with old messages in this
  470. folder. If you enable <guilabel>Expire old messages in this folder</guilabel>
  471. then &kmail; will regularly, depending on your choice, either delete old
  472. messages or move old messages to another folder. You can also start
  473. expiration of old messages manually via <menuchoice><guimenu>Folder</guimenu><guisubmenu>Expire</guisubmenu></menuchoice> and via
  474. <menuchoice><guimenu>File</guimenu><guisubmenu>Expire
  475. All Folders</guisubmenu></menuchoice></para>
  476. <warning><para>Messages that are deleted during expiration of old messages
  477. cannot be restored, so be careful with this setting.</para></warning>
  478. </sect3>
  479. <sect3 id="folders-properties-mailinglist">
  480. <title>Mailing List</title>
  481. <para>If you are going to use the folder for a mailing list then you should
  482. check <guilabel>Folder holds a mailing list</guilabel> to associate this folder
  483. with the mailing list. Next you should
  484. click on <guilabel>Detect Automatically</guilabel>. &kmail; will then try
  485. to guess some information about the mailing list from the currently selected
  486. message. If &kmail; could not determine some addresses then you can add
  487. the missing information manually. To do this first select the
  488. <guilabel>Address type</guilabel> for which you want to add an address.
  489. You can choose between:</para>
  490. <variablelist>
  491. <varlistentry id="folders-properties-mailinglist-post">
  492. <term>
  493. <guilabel>Post to List</guilabel>
  494. </term>
  495. <listitem>
  496. <para>
  497. This address is used for sending messages to the
  498. mailing list. This is usually an email address.
  499. </para>
  500. </listitem>
  501. </varlistentry>
  502. <varlistentry id="folders-properties-mailinglist-subscribe">
  503. <term>
  504. <guilabel>Subscribe to List</guilabel>
  505. </term>
  506. <listitem>
  507. <para>
  508. This address is used for subscribing to the mailing
  509. list. This can be an email address or the address of a
  510. webpage.
  511. </para>
  512. </listitem>
  513. </varlistentry>
  514. <varlistentry id="folders-properties-mailinglist-unsubscribe">
  515. <term>
  516. <guilabel>Unsubscribe from List</guilabel>
  517. </term>
  518. <listitem>
  519. <para>
  520. This address is used for unsubscribing from the
  521. mailing list. This can be an email address or the
  522. address of a webpage.
  523. </para>
  524. </listitem>
  525. </varlistentry>
  526. <varlistentry id="folders-properties-mailinglist-archive">
  527. <term>
  528. <guilabel>List Archives</guilabel>
  529. </term>
  530. <listitem>
  531. <para>
  532. This is the address of the archive of the mailing
  533. list. This is usually the address of a webpage.
  534. </para>
  535. </listitem>
  536. </varlistentry>
  537. <varlistentry id="folders-properties-mailinglist-help">
  538. <term>
  539. <guilabel>List Help</guilabel>
  540. </term>
  541. <listitem>
  542. <para>
  543. This address is used for requesting help for this
  544. mailing list. This is usually an email address.
  545. </para>
  546. </listitem>
  547. </varlistentry>
  548. </variablelist>
  549. <para>After selecting the appropriate <guilabel>Address type</guilabel> you
  550. enter the email address or the address of the webpage and then click on
  551. <guilabel>Add</guilabel>. With <guilabel>Remove</guilabel> you can remove
  552. addresses.</para>
  553. <para>If all addresses have been added then you can execute an action, &eg;
  554. go to the list archives, by selecting the appropriate
  555. <guilabel>Address type</guilabel> and then clicking on
  556. <guilabel>Invoke Handler</guilabel>. If there is an email address and an
  557. address of a webpage for the desired action then you will have to select
  558. the <guilabel>Preferred handler</guilabel> prior to clicking on
  559. <guilabel>Invoke Handler</guilabel>. Select <guilabel>KMail;</guilabel> if you
  560. want to send a message to the email address and select
  561. <guilabel>Browser</guilabel> if you want to go to the webpage.</para>
  562. <para>Alternatively to invoking the handler for
  563. <guilabel>Post to List</guilabel> you can send a new message to the
  564. mailing list via <menuchoice><guimenu>Message</guimenu><guimenuitem>New
  565. Message to Mailing-List...</guimenuitem></menuchoice> or by clicking with
  566. the <mousebutton>middle</mousebutton> mousebutton on the folder in the folder
  567. list.</para>
  568. </sect3>
  569. <sect3 id="folders-properties-acl">
  570. <title>Access Control tab (&imap; only)</title>
  571. <para>
  572. Here you can manage the access control lists (&acl;s) of
  573. &imap; folders.
  574. </para>
  575. <para>
  576. The currently active &acl; is shown in the list. It consists
  577. of pairs of <guilabel>User Id</guilabel>s and the
  578. <guilabel>Permissions</guilabel> granted to users identified
  579. by that <guilabel>User Id</guilabel>.
  580. <footnote>
  581. <para>
  582. Note that a single <guilabel>User Id</guilabel> might
  583. refer to more than one user. Depending on the &imap;
  584. server and its configuration, there may be User Ids
  585. that correspond to groups of users, anonymous users, or
  586. any user. Consult the manual of your specific &imap;
  587. server implementation for more information.
  588. </para>
  589. </footnote>
  590. &acl;s are settable per-folder.
  591. </para>
  592. <note>
  593. <para>
  594. As with everything else when using <emphasis>disconnected
  595. &imap;</emphasis>, you need to sync with the server for
  596. the changes to be transferred to the server.
  597. </para>
  598. </note>
  599. <para>
  600. &imap; &acl;s define a lot of fine-grained permissions that
  601. you can grant or deny other users. For the sake of clarity,
  602. &kmail; will present them as the following five categories
  603. that you can choose from (see <xref
  604. linkend="table-acl-summary"/> for the details if you already
  605. know &imap; &acl;s).
  606. </para>
  607. <variablelist>
  608. <varlistentry id="folders-properties-acl-none">
  609. <term>
  610. <guilabel>None</guilabel>
  611. </term>
  612. <listitem>
  613. <para>
  614. Grants the users identified by <guilabel>User
  615. Id</guilabel> no rights at all. This is also the
  616. default for users not explicitly (or implicitly, as a
  617. group) listed in the &acl;. These users will not see
  618. this folder in the list of &imap; folders presented to
  619. them by their mail clients.
  620. </para>
  621. </listitem>
  622. </varlistentry>
  623. <varlistentry id="folders-properties-acl-read">
  624. <term>
  625. <guilabel>Read</guilabel>
  626. </term>
  627. <listitem>
  628. <para>
  629. Grants the users identified by <guilabel>User
  630. Id</guilabel> reading rights for this folder. This
  631. also includes the ability for their mail clients to
  632. mark mails as read and store this information on the
  633. server.<!-- --><footnote>
  634. <para>
  635. Every user has its own list of read mail, so none
  636. of your unread mails will suddenly be marked as
  637. read just because someone else has already read them.
  638. </para>
  639. </footnote>
  640. </para>
  641. <para>
  642. These users will see this folder in the list of &imap;
  643. folders presented to them by their mail clients.
  644. </para>
  645. <para>
  646. Use this to create a shared folder that others can
  647. read, but not modify.
  648. </para>
  649. <informalexample>
  650. <para>
  651. If you were the editor of a company's news letter,
  652. you could create a folder for the purpose of
  653. distributing the news letter, grant everyone reading
  654. rights, and save the letter to this folder instead
  655. of sending it out by email to a catch-all address.
  656. </para>
  657. </informalexample>
  658. </listitem>
  659. </varlistentry>
  660. <varlistentry id="folders-properties-acl-append">
  661. <term>
  662. <guilabel>Append</guilabel>
  663. </term>
  664. <listitem>
  665. <para>
  666. (also known as <guilabel>Post</guilabel>)
  667. </para>
  668. <para>
  669. Grants the users identified by <guilabel>User
  670. Id</guilabel> reading (see above) and posting rights
  671. for this folder.
  672. </para>
  673. <para>
  674. Use this to create a shared folder that others can
  675. read and post messages to, but can not otherwise
  676. modify.
  677. </para>
  678. <informalexample>
  679. <para>
  680. If you wanted to create a company-wide discussion
  681. forum, instead of using a web-based form or a
  682. separate company-private usenet server, you could
  683. create a bunch of folders (one per topic), and grant
  684. everyone reading and posting rights. Instead of
  685. posting to an &nntp; server or writing their
  686. messages into a web form, people would just write
  687. emails and store them in the folder suiting the
  688. topic of the message.
  689. </para>
  690. </informalexample>
  691. </listitem>
  692. </varlistentry>
  693. <varlistentry id="folders-properties-acl-write">
  694. <term>
  695. <guilabel>Write</guilabel>
  696. </term>
  697. <listitem>
  698. <para>
  699. Grants the users identified by <guilabel>User
  700. Id</guilabel> reading, posting (see above), and
  701. writing rights for this folder.
  702. </para>
  703. <para>
  704. The right to write to a folder includes deleting of
  705. messages, creating subfolders, and storing other
  706. attributes than read/unread on the server (&eg;
  707. answered).
  708. </para>
  709. <para>
  710. Use this to create a shared folder that everyone has
  711. (almost, see <xref linkend="folders-properties-acl-all"/>)
  712. the same rights for.
  713. </para>
  714. <informalexample>
  715. <para>
  716. In the <xref
  717. linkend="folders-properties-acl-append"/> example,
  718. you could assign write rights to a group of people
  719. acting as moderators, which would then be able to
  720. remove off-topic posts, and create sub-topic-folders
  721. for high-traffic folders.
  722. </para>
  723. </informalexample>
  724. </listitem>
  725. </varlistentry>
  726. <varlistentry id="folders-properties-acl-all">
  727. <term>
  728. <guilabel>All</guilabel>
  729. </term>
  730. <listitem>
  731. <para>
  732. Grants the users identified by <guilabel>User
  733. Id</guilabel> reading, posting, writing (see above),
  734. as well as administration rights, &ie; the right to
  735. modify the &acl; of this folder.
  736. </para>
  737. <para>
  738. This is the default set of rights for the owner of a
  739. folder.
  740. </para>
  741. </listitem>
  742. </varlistentry>
  743. </variablelist>
  744. <para>
  745. <xref linkend="table-acl-summary"/> summarizes the &imap;
  746. &acl; rights associated with each permission level.
  747. </para>
  748. <table id="table-acl-summary">
  749. <title>
  750. &acl; Rights Summary
  751. </title>
  752. <tgroup cols="6">
  753. <thead>
  754. <row>
  755. <entry>&acl; right</entry>
  756. <entry><xref linkend="folders-properties-acl-none"/></entry>
  757. <entry><xref linkend="folders-properties-acl-read"/></entry>
  758. <entry><xref linkend="folders-properties-acl-append"/></entry>
  759. <entry><xref linkend="folders-properties-acl-write"/></entry>
  760. <entry><xref linkend="folders-properties-acl-all"/></entry>
  761. </row>
  762. </thead>
  763. <!--tfoot/-->
  764. <tbody>
  765. <row>
  766. <entry>Lookup</entry>
  767. <entry></entry>
  768. <entry>x</entry>
  769. <entry>x</entry>
  770. <entry>x</entry>
  771. <entry>x</entry>
  772. </row>
  773. <row>
  774. <entry>Read</entry>
  775. <entry></entry>
  776. <entry>x</entry>
  777. <entry>x</entry>
  778. <entry>x</entry>
  779. <entry>x</entry>
  780. </row>
  781. <row>
  782. <entry>Store Seen</entry>
  783. <entry></entry>
  784. <entry>x</entry>
  785. <entry>x</entry>
  786. <entry>x</entry>
  787. <entry>x</entry>
  788. </row>
  789. <row>
  790. <entry>Insert</entry>
  791. <entry></entry>
  792. <entry></entry>
  793. <entry>x</entry>
  794. <entry>x</entry>
  795. <entry>x</entry>
  796. </row>
  797. <row>
  798. <entry>Post</entry>
  799. <entry></entry>
  800. <entry></entry>
  801. <entry>x</entry>
  802. <entry>x</entry>
  803. <entry>x</entry>
  804. </row>
  805. <row>
  806. <entry>Write Flags</entry>
  807. <entry></entry>
  808. <entry></entry>
  809. <entry></entry>
  810. <entry>x</entry>
  811. <entry>x</entry>
  812. </row>
  813. <row>
  814. <entry>Create</entry>
  815. <entry></entry>
  816. <entry></entry>
  817. <entry></entry>
  818. <entry>x</entry>
  819. <entry>x</entry>
  820. </row>
  821. <row>
  822. <entry>Delete</entry>
  823. <entry></entry>
  824. <entry></entry>
  825. <entry></entry>
  826. <entry>x</entry>
  827. <entry>x</entry>
  828. </row>
  829. <row>
  830. <entry>Administer</entry>
  831. <entry></entry>
  832. <entry></entry>
  833. <entry></entry>
  834. <entry></entry>
  835. <entry>x</entry>
  836. </row>
  837. </tbody>
  838. </tgroup>
  839. </table>
  840. </sect3>
  841. </sect2>
  842. <sect2 id="folders-format">
  843. <title>Folder Format</title>
  844. <para>A message folder can be either in <guilabel>mbox</guilabel> or in <guilabel>maildir</guilabel>
  845. format. <guilabel>mbox</guilabel> saves all messages of a folder to one file,
  846. whereas <guilabel>maildir</guilabel> saves each message to its own file.
  847. <guilabel>maildir</guilabel>, which is the default format, can be considered more
  848. robust, but it can be slower on some file systems. If you are unsure,
  849. choose <guilabel>maildir</guilabel>.</para>
  850. <para>Note that there is currently no feature in &kmail; that allows you to convert
  851. between both formats automatically, but you can just move all messages from an old
  852. <guilabel>mbox</guilabel> folder to a new <guilabel>maildir</guilabel> folder or
  853. vice-versa.</para>
  854. </sect2>
  855. </sect1>
  856. <sect1 id="filters">
  857. <title>Message Filters</title>
  858. <anchor id="filters-id"/>
  859. <para>After using &kmail; for a while, you may find that you have trouble
  860. sorting out the new messages in your inbox when they arrive. Filters allow you
  861. to automatically perform certain actions on incoming messages and to manually
  862. perform actions on selected messages in a folder.</para>
  863. <para>Please note that the filters described in this section are
  864. applied <emphasis>after</emphasis> the messages have been downloaded
  865. from your account -- if you want to filter messages on the server, see
  866. <link linkend="popfilters">Download Filters</link>.</para>
  867. <para>Filters consist of: filter criteria, whose rules are used as
  868. criteria to determine whether this filter should be applied to a given
  869. message; and a list of filter actions, which describe what is to be
  870. done with, or to, the message if the search pattern matches. Read more
  871. about filter criteria and filter actions in the following
  872. subsections.</para>
  873. <note><para>Filters are considered one after the other,
  874. starting with the first filter in the list. The first one whose
  875. pattern matches the given message gets executed; you can request that
  876. the remaining filters also be applied, but the default is to stop
  877. processing at the first matching filter. </para></note>
  878. <para>Usually, filters are used on incoming messages, but they can
  879. also be applied to sent messages or to an arbitrary message or group
  880. of messages. To selectively filter messages, select the messages you
  881. want to filter in the message list and either type <keycombo
  882. action="simul">&Ctrl;<keycap>J</keycap> </keycombo> or select
  883. <menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply
  884. Filters</guimenuitem></menuchoice>: this will apply all filters that
  885. have been marked for manual filtering in the <link
  886. linkend="filter-dialog">filter dialog</link> to those messages.</para>
  887. <sect2 id="filter-quick">
  888. <title>Fast Filter Creation</title>
  889. <para>There are two methods for creating a filter; the quick method is
  890. to use <menuchoice><guimenu>Message</guimenu><guimenuitem>Create
  891. Filter</guimenuitem></menuchoice>: this will call the filter dialog
  892. and present you with a new filter which has the first rule of the
  893. search pattern and the first action (as <guilabel>Move into Folder</guilabel>)
  894. preset. In most cases, all you have to do is select the folder where the message
  895. should be moved to; but you can, of course, edit the filter as you
  896. like.</para>
  897. <para>When creating a filter on mailing list messages this method
  898. will try really hard to find a criterion that
  899. uniquely identifies messages from that list; If it succeeds, the guessed
  900. name of the list is presented in the
  901. <menuchoice><guimenu>Message</guimenu><guisubmenu>Create
  902. Filter</guisubmenu><guimenuitem>Filter on
  903. Mailing-List...</guimenuitem></menuchoice> menu entry.</para>
  904. <para>The second method is to manually construct a filter from scratch
  905. by calling the filter dialog through
  906. <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  907. Filters...</guimenuitem></menuchoice>. The filter dialog is described in
  908. detail in the following subsection.</para>
  909. </sect2>
  910. <sect2 id="filter-dialog">
  911. <title>The Filter Dialog</title>
  912. <anchor id="filter-dialog-id"/>
  913. <para>This dialog allows you to manage and edit your list of
  914. filters.</para>
  915. <para>You can reach it either via
  916. <menuchoice><guimenu>Message</guimenu><guisubmenu>Create
  917. Filter</guisubmenu></menuchoice> or
  918. <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  919. Filters...</guimenuitem></menuchoice>.</para>
  920. <para>The dialog is divided into four main sections:</para>
  921. <variablelist>
  922. <varlistentry>
  923. <term><guilabel>Available Filters</guilabel></term>
  924. <listitem><para>This group contains the list of filters and some action
  925. buttons to modify the filters, namely: to create new filters; to move them up or
  926. down the list; to delete them; or to rename them. If you select
  927. a filter from the list, its properties are shown in the right-hand half
  928. of the dialog.</para></listitem>
  929. </varlistentry>
  930. <varlistentry>
  931. <term><guilabel>Filter Criteria</guilabel></term> <listitem><para>In
  932. this group you can edit the pattern that messages must match for the
  933. filter to be applied to them. You can select here whether all of the
  934. defined rules must match or whether it suffices that any one of them
  935. matches. See <link linkend="filter-criteria">Search Patterns</link>
  936. below for a detailed description of each search rule type.</para>
  937. <para> You can click on <guibutton>More</guibutton> to get an
  938. additional (initially empty) rule if you want to define more-complex
  939. patterns and on <guibutton>Fewer</guibutton> to remove the last
  940. rule. <guibutton>Clear</guibutton> clears the pattern, &ie; it removes
  941. all but two rules from screen and resets those two.</para>
  942. <para>Invalid or empty rules are not evaluated.</para>
  943. </listitem>
  944. </varlistentry>
  945. <varlistentry>
  946. <term><guilabel>Filter Actions</guilabel></term> <listitem><para>In
  947. this group you can edit the list of actions that are applied to all
  948. messages that match the defined filter criteria. See <link
  949. linkend="filter-action">Filter Actions</link> below for a detailed
  950. description of each action type.</para>
  951. <para> You can click on <guibutton>More</guibutton> to get a new,
  952. empty action (if you want to define more than one action) and on
  953. <guibutton>Fewer</guibutton> to remove the last
  954. action. <guibutton>Clear</guibutton> clears the list, &ie; it
  955. removes all but one action and resets that one.</para>
  956. <para>Invalid or empty actions are not executed.</para>
  957. </listitem>
  958. </varlistentry>
  959. <varlistentry>
  960. <term><guilabel>Advanced Options</guilabel></term>
  961. <listitem>
  962. <para>In this group you can define a few advanced options for filters
  963. that allow you to refine your filtering.</para>
  964. <para>Using the first row of check boxes, you can toggle when the
  965. filter is applied: the <guilabel>to incoming messages</guilabel>
  966. option means that the filter is applied to messages when you receive
  967. them (&ie; on <guiicon>Check Mail</guiicon>); the <guilabel>to sent
  968. messages</guilabel> options means that the filter is applied to
  969. messages when you send them and the <guilabel>on manual
  970. filtering</guilabel> option controls whether to apply this filter when
  971. filtering is specifically selected (&ie; via
  972. <menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply
  973. Filters</guimenuitem></menuchoice>.)</para>
  974. <para>The <guilabel>If this filter matches, stop processing here</guilabel>
  975. check box in the second row controls whether or not the filters after
  976. the current filter will be applied, if the current filter matches.</para>
  977. <para>If the <guilabel>Add this filter to the Apply Filter menu</guilabel>
  978. check box in the third row is selected, this filter will be inserted
  979. in the <menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply
  980. Filter</guimenuitem></menuchoice> submenu. You can then apply this
  981. filter to a message. Another way of applying filters is to use
  982. <menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply
  983. Filters</guimenuitem></menuchoice> menu option, which applies <emphasis>all</emphasis>
  984. the filters - one after another until they are all used or one of the
  985. filters that matches has the <guilabel>If the filters matches, stop
  986. processing here</guilabel>.</para>
  987. </listitem>
  988. </varlistentry>
  989. </variablelist>
  990. <note><para>Filters are automatically named unless you explicitly
  991. rename them using the <guibutton>Rename...</guibutton> button.
  992. The dialog assumes that it should continue auto-naming the filter
  993. as long as the filter name starts with <quote>&lt;</quote>.
  994. </para></note>
  995. <note>
  996. <para>If you apply filter changes, via
  997. <guibutton>OK</guibutton> or <guibutton>Apply</guibutton>, only valid
  998. filters are actually copied to the internal filter manager.</para>
  999. <para>Similarly, empty rules and actions are removed from the pattern
  1000. and action list respectively, before the filter is saved.</para>
  1001. </note>
  1002. </sect2>
  1003. <sect2 id="filter-criteria">
  1004. <title>Search Patterns</title>
  1005. <para>The most common use of filters is to filter on the sender of
  1006. messages; this can be done by choosing <guilabel>From</guilabel>. A
  1007. good bet for a mailing list would be
  1008. <guilabel>&lt;recipients&gt;</guilabel>, but there are other criteria
  1009. a filter can search for (note that all patterns are interpreted
  1010. case-insensitively):</para>
  1011. <variablelist>
  1012. <varlistentry>
  1013. <term><guilabel>&lt;message&gt;</guilabel></term>
  1014. <listitem>
  1015. <para>Searches the whole message (&ie; headers, body and attachments,
  1016. if any);</para>
  1017. </listitem>
  1018. </varlistentry>
  1019. <varlistentry>
  1020. <term><guilabel>&lt;body&gt;</guilabel></term>
  1021. <listitem>
  1022. <para>Searches the body of the message (&ie; the whole message except the headers);</para>
  1023. </listitem>
  1024. </varlistentry>
  1025. <varlistentry>
  1026. <term><guilabel>&lt;any header&gt;</guilabel></term>
  1027. <listitem>
  1028. <para>Searches the headers of the message;</para>
  1029. </listitem>
  1030. </varlistentry>
  1031. <varlistentry>
  1032. <term><guilabel>&lt;recipients&gt;</guilabel></term>
  1033. <listitem>
  1034. <para>Searches the <quote>To</quote> and <quote>CC</quote> header fields of the message;</para>
  1035. </listitem>
  1036. </varlistentry>
  1037. <varlistentry>
  1038. <term><guilabel>&lt;size in bytes&gt;</guilabel></term>
  1039. <listitem>
  1040. <para>Sets upper or lower bounds on the message size;</para>
  1041. </listitem>
  1042. </varlistentry>
  1043. <varlistentry>
  1044. <term><guilabel>&lt;age in days&gt;</guilabel></term>
  1045. <listitem>
  1046. <para>Sets upper or lower bounds on the message age;</para>
  1047. </listitem>
  1048. </varlistentry>
  1049. <varlistentry>
  1050. <term><guilabel>&lt;status&gt;</guilabel></term>
  1051. <listitem>
  1052. <para>Sets restrictions on the status of the message;</para>
  1053. </listitem>
  1054. </varlistentry>
  1055. <varlistentry>
  1056. <term>Any other name</term>
  1057. <listitem>
  1058. <para>Searches the header field that is given by that name.</para>
  1059. </listitem>
  1060. </varlistentry>
  1061. </variablelist>
  1062. <para>The list of possible rules depends on what you selected in the first
  1063. drop down box. The available rules are:</para>
  1064. <informaltable>
  1065. <tgroup cols="3">
  1066. <thead>
  1067. <row>
  1068. <entry>Rule</entry>
  1069. <entry>Available for</entry>
  1070. <entry>Description</entry>
  1071. </row>
  1072. </thead>
  1073. <tbody>
  1074. <row>
  1075. <entry><guilabel>contains</guilabel>/<guilabel>does not contain</guilabel></entry>
  1076. <entry>all textual search items</entry>
  1077. <entry>Matches if the searched item contains (or does not contain) the given
  1078. text.</entry>
  1079. </row>
  1080. <row>
  1081. <entry><guilabel>equals</guilabel>/<guilabel>does not equal</guilabel></entry>
  1082. <entry>most textual search items</entry>
  1083. <entry>Matches if the searched item is equal to (or not equal to) the given
  1084. text.</entry>
  1085. </row>
  1086. <row>
  1087. <entry><guilabel>matches regular expr.</guilabel>/<guilabel>does not match reg. expr.</guilabel></entry>
  1088. <entry>all textual search items</entry>
  1089. <entry>Matches if a part of the searched item matches the given regular
  1090. expression (or does not match it). If the regular expression editor is
  1091. installed then you can edit the regular expression by clicking on the <guilabel>Edit...</guilabel> button.</entry>
  1092. </row>
  1093. <row>
  1094. <entry><guilabel>has an attachment</guilabel>/<guilabel>has no attachment</guilabel></entry>
  1095. <entry><guilabel>&lt;message&gt;</guilabel></entry>
  1096. <entry>Matches if the message has an attachment (or does not have an attachment).</entry>
  1097. </row>
  1098. <row>
  1099. <entry><guilabel>is in address book</guilabel>/<guilabel>is not in address book</guilabel></entry>
  1100. <entry>most textual search items</entry>
  1101. <entry>Matches if the searched item contains an address that is in your address
  1102. book (or if the searched items contains only unknown addresses). Of course,
  1103. this rule makes only sense for address fields like From or
  1104. <guilabel>&lt;recipients&gt;</guilabel></entry>
  1105. </row>
  1106. <row>
  1107. <entry><guilabel>is in category</guilabel>/<guilabel>is not in category</guilabel></entry>
  1108. <entry>most textual search items</entry>
  1109. <entry>Matches if the searched item contains an address that is in the
  1110. specified category in your address book (or if the searched item contains
  1111. no address that is in the specified category). Again, this rule makes only
  1112. sense for address fields.</entry>
  1113. </row>
  1114. <row>
  1115. <entry><guilabel>is equal to</guilabel>/<guilabel>is not equal to</guilabel></entry>
  1116. <entry>numerical search items</entry>
  1117. <entry>Matches if the value of the search item is equal to (or not equal to)
  1118. the specified value.</entry>
  1119. </row>
  1120. <row>
  1121. <entry><guilabel>is less than</guilabel></entry>
  1122. <entry>numerical search items</entry>
  1123. <entry>Matches if the value of the search item is less than
  1124. the specified value.</entry>
  1125. </row>
  1126. <row>
  1127. <entry><guilabel>is greater than</guilabel></entry>
  1128. <entry>numerical search items</entry>
  1129. <entry>Matches if the value of the search item is greater than
  1130. the specified value.</entry>
  1131. </row>
  1132. <row>
  1133. <entry><guilabel>is less than or equal to</guilabel></entry>
  1134. <entry>numerical search items</entry>
  1135. <entry>Matches if the value of the search item is less than or equal to
  1136. the specified value.</entry>
  1137. </row>
  1138. <row>
  1139. <entry><guilabel>is greater than or equal to</guilabel></entry>
  1140. <entry>numerical search items</entry>
  1141. <entry>Matches if the value of the search item is greater than or equal to
  1142. the specified value.</entry>
  1143. </row>
  1144. <row>
  1145. <entry><guilabel>is</guilabel>/<guilabel>is not</guilabel></entry>
  1146. <entry><guilabel>&lt;status&gt;</guilabel></entry>
  1147. <entry>Matches if the message has (or does not have) the specified status.</entry>
  1148. </row>
  1149. </tbody>
  1150. </tgroup>
  1151. </informaltable>
  1152. </sect2>
  1153. <sect2 id="filter-action">
  1154. <title>Filter Action</title>
  1155. <para>The most common use of filters is to sort incoming messages to
  1156. certain folders; this can be done by choosing <guilabel>Move into
  1157. Folder</guilabel>. Here is a list of all possible actions:</para>
  1158. <variablelist>
  1159. <varlistentry>
  1160. <term><guilabel>Move into Folder</guilabel></term>
  1161. <listitem>
  1162. <para>This will file the message into another folder, removing it from
  1163. its current folder if necessary; you cannot, currently
  1164. use &imap; folders as a target.</para>
  1165. <!-- fixme: still correct? -->
  1166. </listitem>
  1167. </varlistentry>
  1168. <varlistentry>
  1169. <term><guilabel>Copy to Folder</guilabel></term>
  1170. <listitem>
  1171. <para>This will copy the message to another folder.</para>
  1172. <note><para>You currently cannot use &imap;
  1173. folders as a target.</para></note>
  1174. </listitem>
  1175. </varlistentry>
  1176. <varlistentry>
  1177. <term><guilabel>Set Identity To</guilabel></term>
  1178. <listitem>
  1179. <para>This will set the identity that will be used if you reply to this
  1180. message.</para>
  1181. </listitem>
  1182. </varlistentry>
  1183. <varlistentry>
  1184. <term><guilabel>Mark As</guilabel></term>
  1185. <listitem>
  1186. <para>This allows you to mark the message as read or important (flagged), but
  1187. also as forwarded, replied, &etc;</para>
  1188. </listitem>
  1189. </varlistentry>
  1190. <varlistentry>
  1191. <term><guilabel>Send Fake MDN</guilabel></term>
  1192. <listitem>
  1193. <para>This will send a faked message disposition notification (&ie; a read
  1194. receipt) to the sender of the message.</para>
  1195. </listitem>
  1196. </varlistentry>
  1197. <varlistentry>
  1198. <term><guilabel>Set Transport To</guilabel></term>
  1199. <listitem>
  1200. <para>This will set the method of transport (&eg; <acronym>SMTP</acronym>)
  1201. that will be used if you reply to the message.</para>
  1202. </listitem>
  1203. </varlistentry>
  1204. <varlistentry>
  1205. <term><guilabel>Set Reply-To To</guilabel></term>
  1206. <listitem><para>This will modify the <guilabel>Reply-To</guilabel> field of this
  1207. message. This can be useful for mailing lists that automatically set a Reply-To
  1208. which you do not like.</para>
  1209. </listitem>
  1210. </varlistentry>
  1211. <varlistentry>
  1212. <term><guilabel>Forward To</guilabel></term>
  1213. <listitem><para>This will forward the message inline (&ie; as if you selected <menuchoice><guimenu>Message</guimenu><guimenuitem>Forward</guimenuitem><guimenuitem>Inline...</guimenuitem></menuchoice>) to another email address. You can select the template to be used when forwarding with this filter with the drop down list.</para>
  1214. </listitem>
  1215. </varlistentry>
  1216. <varlistentry>
  1217. <term><guilabel>Redirect To</guilabel></term>
  1218. <listitem><para>This will redirect the message as-is to another email address.</para>
  1219. </listitem>
  1220. </varlistentry>
  1221. <varlistentry>
  1222. <term><guilabel>Confirm Delivery</guilabel></term>
  1223. <listitem><para>Will try to return a message to the sender that
  1224. indicates successful delivery of their message, if the sender requested that.</para> <para>This
  1225. action allows you to select who will get delivery receipts from
  1226. you. <!-- FIXME: removed-->Though you can globally enable the sending of delivery
  1227. confirmations in the <guilabel>Configure &kmail;...</guilabel> dialog
  1228. (<link linkend="configure-security"><guilabel>Security</guilabel>
  1229. page</link>) we recommended not to send them to everyone, since this
  1230. makes tracking of spam messages, for example, very easy for the sender.</para>
  1231. </listitem>
  1232. </varlistentry>
  1233. <varlistentry>
  1234. <term><guilabel>Execute Command</guilabel></term>
  1235. <listitem>
  1236. <para>This will execute a program, but will not modify the
  1237. message. Specify the full path to the program you want to
  1238. execute; &kmail; will then block until the program returns.
  1239. If you do not want &kmail; to block then append '&amp;' to the command.
  1240. You can feed
  1241. the program with the parts of the mail: <symbol>&percnt;0</symbol>,
  1242. <symbol>&percnt;1</symbol>, &etc; stand for files representing
  1243. the message parts; for common messages <symbol>&percnt;0</symbol> is the
  1244. text, <symbol>&percnt;1</symbol> the first attachment and so
  1245. on. Additionally, the whole message is fed into the program's
  1246. <acronym>stdin</acronym>; and every occurrence of
  1247. <symbol>&percnt;{foo}</symbol> is replaced by the content of the foo
  1248. header.</para>
  1249. <!-- fixme: still correct? -->
  1250. <warning><para>This currently only works if the message has
  1251. <emphasis>at least one</emphasis> attachment. No, not even
  1252. <symbol>&percnt;0</symbol> will work in the general
  1253. case!</para></warning>
  1254. <tip><para> You can enter arbitrarily-complex shell commands here,
  1255. since &kmail; uses a sub shell to execute the command line; therefore,
  1256. even this command will work (within its limits):
  1257. <userinput><command>uudecode</command> <option>-o</option>
  1258. <parameter>$(mktemp kmail-uudecoded.XXXXXX)</parameter> &amp;&amp;
  1259. <command>echo</command> <parameter>$'\a'</parameter></userinput></para></tip>
  1260. <!-- fixme: is this uudecode tip useless now?? -->
  1261. </listitem>
  1262. </varlistentry>
  1263. <varlistentry>
  1264. <term><guilabel>Pipe Through</guilabel></term>
  1265. <listitem>
  1266. <para>This will feed the message to a program: if the program returns
  1267. output, the entire message (including the headers) will be replaced
  1268. with this output; if the program does not return output or exits
  1269. with a return code other than 0 (indicating an error occurred), the message
  1270. will not change. Specify the full path to the program. The same
  1271. substitutions (<symbol>&percnt;n</symbol>,
  1272. <symbol>&percnt;{foo}</symbol> as with <guilabel>execute
  1273. command</guilabel> are performed on the command line.</para>
  1274. <warning><para>Be cautious with this action, as it will easily mess up
  1275. your messages if the filter program returns garbage or extra
  1276. lines.</para></warning>
  1277. </listitem>
  1278. </varlistentry>
  1279. <varlistentry>
  1280. <term><guilabel>Remove Header</guilabel></term>
  1281. <listitem>
  1282. <para>Will remove all header fields with the
  1283. given name from the message. This is useful mainly for removing bogus
  1284. <quote>Reply-To:</quote> headers.</para>
  1285. </listitem>
  1286. </varlistentry>
  1287. <varlistentry>
  1288. <term><guilabel>Add Header</guilabel></term>
  1289. <listitem>
  1290. <para>If no such field is already present this will add a new header field
  1291. with the given name and value to the message; if there already is a
  1292. header field with that name, it is overwritten with the
  1293. given value; if there are already multiple headers with the given
  1294. name (&eg; <quote>Received:</quote> headers), an arbitrary one of them is
  1295. overwritten and the others are left unchanged -- this is a known
  1296. limitation. You may want to combine this filter with the
  1297. <guilabel>remove header</guilabel> filter above to make sure that
  1298. there are no other headers with that name in the message.</para>
  1299. </listitem>
  1300. </varlistentry>
  1301. <varlistentry>
  1302. <term><guilabel>Rewrite Header</guilabel></term>
  1303. <listitem>
  1304. <para>Will scan the given header field, modify its contents and write
  1305. it back. The search string is always interpreted as a case-sensitive
  1306. regular expression. The replacement string is inserted literally
  1307. except for occurrences of <userinput>\n</userinput>,
  1308. <userinput>$n</userinput> and <userinput>${nn}</userinput>, where
  1309. <userinput>n</userinput> is a positive (single-digit, except for the
  1310. third form) number or <userinput>0</userinput>. These constructs are
  1311. interpreted as back references to substrings captured with parentheses
  1312. in the search string.</para><para>Analogous restrictions as in the
  1313. <guilabel>add header</guilabel> action apply here, too.</para>
  1314. </listitem>
  1315. </varlistentry>
  1316. <varlistentry>
  1317. <term><guilabel>Play Sound</guilabel></term>
  1318. <listitem>
  1319. <para>Will play the specified sound.</para>
  1320. </listitem>
  1321. </varlistentry>
  1322. </variablelist>
  1323. </sect2>
  1324. <sect2 id="filter-examples">
  1325. <title>Filter Examples</title>
  1326. <para>If I am subscribed to the (general) &kde; List, I could create a
  1327. folder for the list (I will call it
  1328. <replaceable>KDE-General</replaceable>) and use a filter to
  1329. automatically transfer new messages from my inbox to my
  1330. <replaceable>KDE-General</replaceable> folder if they are from the
  1331. &kde; List. Here is how to create this filter:</para>
  1332. <procedure>
  1333. <title>Filtering a mailing list</title>
  1334. <step>
  1335. <para>Try if <menuchoice><guimenu>Message</guimenu><guisubmenu>Create
  1336. filter</guisubmenu><guimenuitem>Filter on
  1337. Mailing-List...</guimenuitem></menuchoice> can identify the mailing
  1338. list (the name of the list should then appear in the menu item); in
  1339. this case, this works and I am presented a filter that has
  1340. <quote>List-Id<guilabel>contains</guilabel>
  1341. &lt;;</quote> preset. You select the
  1342. desired destination folder from the folder pull-down menu in the
  1343. <guilabel>Filter Action</guilabel> group and that is it.</para>
  1344. <para>If that does not work, think of a unique way of identifying the
  1345. messages you want to filter. The (almost) unique property of my &kde;
  1346. List messages is that they always contain
  1347. <quote></quote> in the
  1348. <guilabel>To:</guilabel> or <guilabel>CC:</guilabel> field. It is only
  1349. almost unique, because this fails for cross-posted messages.</para>
  1350. </step>
  1351. <step>
  1352. <para>Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
  1353. Filters...</guimenuitem></menuchoice>.</para>
  1354. </step>
  1355. <step>
  1356. <para>Press the <guibutton>New</guibutton> button to create an empty
  1357. filter. It will appear as <guilabel>&lt;unknown&gt;</guilabel>.</para>
  1358. </step>
  1359. <step>
  1360. <para>In the <guilabel> Filter Criteria</guilabel> area, select
  1361. <guilabel>&lt;recipients&gt;</guilabel> from the first drop-down box,
  1362. <guilabel>contains</guilabel> from the second drop-down box, and type
  1363. <userinput></userinput> in the text
  1364. field.</para>
  1365. </step>
  1366. <step>
  1367. <para>Skip down to the <guilabel>Filter Actions</guilabel> section. Select <guilabel>file into
  1368. folder</guilabel> from the first drop-down box. A new drop-down box
  1369. containing a list of folders will appear. Select the folder that you
  1370. want the filtered messages to be transferred to. For this example, you would select
  1371. <guilabel>KDE-General</guilabel> from the drop-down box.</para>
  1372. </step>
  1373. </procedure>
  1374. <para>You may find that you need to use more powerful criteria to
  1375. properly filter your messages; for example, you may only want to
  1376. filter the &kde; List messages that are written by your friend <replaceable>Fred
  1377. Johnson &lt;;</replaceable>. This is where the rest of the
  1378. matching criteria section comes into play:</para>
  1379. <procedure>
  1380. <title>Extending the filter</title>
  1381. <step>
  1382. <para>Open up the <guilabel>Configure Filters...</guilabel> window and select
  1383. the filter you just created.</para>
  1384. </step>
  1385. <step>
  1386. <para>Since you want to filter all messages that have
  1387. <replaceable></replaceable> in the
  1388. <guilabel>To:</guilabel> or <guilabel>CC:</guilabel> field
  1389. <emphasis>and</emphasis> that are from Fred, check the
  1390. <guibutton>Match all of the following</guibutton> radio
  1391. button.</para>
  1392. </step>
  1393. <step>
  1394. <para>Now, go to the second search rule and select the following from
  1395. the pull-down menus: <guilabel>From</guilabel>,
  1396. <guilabel>contains</guilabel>. Now, type
  1397. <userinput></userinput> in the text field.</para>
  1398. </step>
  1399. </procedure>
  1400. <para>You now have a filter that transfers all &kde; List messages
  1401. that are from <userinput></userinput>.</para>
  1402. <!-- fixme: trigger with ctrl-j or whenever new mail arrives (unless
  1403. <guilabel>Advanced Options</guilabel> are changed. -->
  1404. </sect2>
  1405. <sect2 id="filter-optimization">
  1406. <title>Filter Optimization</title>
  1407. <para>It is important to know that, for example, the order of the
  1408. filters has an impact on the speed of the filter process. Here are
  1409. some ideas which can help you to improve the filtering:
  1410. </para>
  1411. <variablelist>
  1412. <varlistentry>
  1413. <term>Stop filter processing as early as possible:</term>
  1414. <listitem>
  1415. <para>If you know that a filter finally processes a certain class of
  1416. messages, please make sure to check the option <guilabel>If this filter
  1417. matches, stop processing here</guilabel> for the filter.
  1418. This will avoid the evaluation of the filter rules of all subsequent
  1419. filters. (See the advanced options in the <link linkend="filter-dialog-id">
  1420. Filter Dialog</link>).</para>
  1421. <para>An example is filtering messages from mailing lists via List-Id
  1422. header into separate folders. Having found out that a message came from
  1423. list A means that you can avoid checking the next filter for messages
  1424. from list B.
  1425. </para>
  1426. </listitem>
  1427. </varlistentry>
  1428. <varlistentry>
  1429. <term>Consider the costs of the evaluation of filter rules:</term>
  1430. <listitem>
  1431. <para>The time required to evaluate a filter rule depends on the way
  1432. the rule is constructed. In particular, scanning for a
  1433. substring using the <guilabel>contains</guilabel> operation is faster
  1434. than a pattern matching using the <guilabel>matches regular
  1435. expr.</guilabel> operation.
  1436. </para>
  1437. <para>Another dependency is on the amount of data which is used for the
  1438. evaluation of a filter rule. If the rule is based on a message header,
  1439. its evaluation should normally be much faster than the evaluation of
  1440. a rule based on the complete message.
  1441. </para>
  1442. <para>You should try to keep the filter rules as simple as possible.
  1443. </para>
  1444. </listitem>
  1445. </varlistentry>
  1446. <varlistentry>
  1447. <term>Check the order of your filters:</term>
  1448. <listitem>
  1449. <para>All the different filter actions have a different complexity.
  1450. The most expensive filter actions are <guilabel>pipe through</guilabel>
  1451. and <guilabel>execute command</guilabel>, because both need external
  1452. programs to be run. Placing filters containing these filter actions
  1453. behind other filters that can reduce the number of times these complex
  1454. actions are required is useful, if the filter logic does allow
  1455. this.</para>
  1456. <para>An example is filtering messages from a mailing list and detecting
  1457. spam messages. For the spam detection you will usually use an external
  1458. tool via a <guilabel>pipe through</guilabel> action. Filtering the messages
  1459. for the mailing list is done via the List-Id header. If you do not want to
  1460. check the messages from the mailing list for spam too, it is better to
  1461. use the filter for the mailing list messages before the filter for the
  1462. spam detection. This way you avoid the expensive and slow spam check for all
  1463. messages which were identified as mailing list messages.
  1464. </para>
  1465. </listitem>
  1466. </varlistentry>
  1467. </variablelist>
  1468. </sect2>
  1469. <sect2 id="filter-logging">
  1470. <title>Filter Log</title>
  1471. <para>If you want to verify that your filters work as intended, you can
  1472. open a viewer for the filter log via <menuchoice><guimenu>Tools</guimenu>
  1473. <guimenuitem>Filter Log Viewer...</guimenuitem></menuchoice>.
  1474. </para>
  1475. <para>In the viewer, there you can configure the logging of the filter
  1476. processing. You can control the detail level of the log, clear the log
  1477. or save the log into a file. The log can provide valuable information if
  1478. you need to debug your filtering process.
  1479. </para>
  1480. </sect2>
  1481. </sect1>
  1482. <!-- dnaber update 2004-02-22 -->
  1483. <sect1 id="popfilters">
  1484. <title>Download Filters</title>
  1485. <para>Download Filters can be used to filter mail from a POP server,
  1486. <emphasis>before</emphasis> they are completely downloaded; you can use them
  1487. to prevent &kmail; from downloading huge messages and save time this
  1488. way.</para>
  1489. <para>In the configuration dialog of the POP account you can enable
  1490. download filtering by checking the <guilabel>Filter messages if
  1491. they are greater than</guilabel> box; once you have done that, you can specify a size
  1492. which is used as a threshold: messages exceeding this size will be
  1493. checked against the filter rules you defined -- if no filter rule
  1494. matches, they will be shown in a confirmation dialog and you can
  1495. decide what to do with them. The default size for filtering is 50,000
  1496. Bytes; this is a good value as the overhead is kept to a minimum --
  1497. every message that is looked at by the filter causes additional
  1498. traffic because the header of the message is downloaded twice. The
  1499. default action is <guilabel>Download mail</guilabel> to prevent the
  1500. loss of messages.</para>
  1501. <warning><para>Be careful with the <guilabel>Delete mail from
  1502. server</guilabel> option since once a mail is deleted on the server
  1503. there is no way to get it back.</para></warning>
  1504. <para>With a really good set of filter rules, it is possible that all
  1505. messages that exceed the threshold size are automatically tagged
  1506. (&ie; downloaded, kept on the server or deleted) and you would never
  1507. be bugged by the confirmation dialog. Be careful though, since once a
  1508. message is matched by a filter rule, you have no guarantee that you
  1509. can change the action before it is executed: the confirmation dialog will
  1510. be displayed <emphasis>only</emphasis> if there is a message left that
  1511. was not matched by a filter rule.</para>
  1512. <sect2 id="popfilters-dialog">
  1513. <title>The <guilabel>Configure Pop Filter</guilabel> Dialog</title>
  1514. <para>Adding filter rules works similar as for <link
  1515. linkend="filters">message filters</link>. On the left hand side you
  1516. can manage the existing filters. Use the <guiicon>New</guiicon>
  1517. button to add a filter. On the right hand side you can configure
  1518. under which conditions the current filter should match. Using <guilabel>Filter
  1519. Action</guilabel> you specify what will happen to a message that is
  1520. matched by this rule. The available options are:</para>
  1521. <variablelist>
  1522. <varlistentry>
  1523. <term><guilabel>Download mail</guilabel></term>
  1524. <listitem>
  1525. <para>Will download the messages matched by the filter, just as any other message
  1526. that does not exceed the threshold size.</para>
  1527. </listitem>
  1528. </varlistentry>
  1529. <varlistentry>
  1530. <term><guilabel>Download mail later</guilabel></term>
  1531. <listitem>
  1532. <para>Will tag the messages for later download. This means the messages matched
  1533. will stay on the POP server until you choose to download them by
  1534. changing the action manually.</para></listitem>
  1535. </varlistentry>
  1536. <varlistentry>
  1537. <term><guilabel>Delete mail from server</guilabel></term>
  1538. <listitem>
  1539. <para>Will delete the message from the server and does not download it. Once you
  1540. deleted a message from the server, there is <emphasis>no</emphasis> way you can undo this.
  1541. Be careful, as rules could match messages you actually want, too.</para></listitem>
  1542. </varlistentry>
  1543. </variablelist>
  1544. <para>The option <guilabel>Always show matched 'Download Later' messages in
  1545. confirmation dialog</guilabel> will cause the confirmation dialog to
  1546. show up during mailbox check if at least one message was tagged for
  1547. <guilabel>Download Later</guilabel> - even if all messages exceeding
  1548. the threshold size were matched by a rule. This option is useful in the
  1549. case you have messages matched by a rule and tagged for
  1550. <guilabel>Download Later</guilabel>, but you do not get any message
  1551. exceeding the size limit for a very long time. Without this option,
  1552. the confirmation dialog would never show up and you would never have
  1553. a chance to get the queued message by changing the action manually.</para>
  1554. </sect2>
  1555. <sect2 id="popfilters-confirmation">
  1556. <title>The Confirmation Dialog</title>
  1557. <para>This dialog shows up whenever you have POP filtering switched
  1558. on and messages were found on the server that exceed the threshold
  1559. size you defined for the POP account. Now you have the chance to
  1560. decide what you want to do with that message. The options are
  1561. <guilabel>Download</guilabel> (green), <guilabel>Download
  1562. later</guilabel> (yellow with egg watch) and <guilabel>Delete from
  1563. server</guilabel> (red <quote>X</quote>). Be cautious with the delete
  1564. option, since once you deleted a mail from the server, there is no
  1565. way to undelete it again.</para>
  1566. <para>In the <guilabel>Filtered Messages</guilabel> section you can
  1567. check the box if you receive messages that were automatically tagged for
  1568. a certain action (download, download later, delete) by a filter rule.
  1569. The checkbox is only enabled if you receive some messages that were
  1570. matched by a filter rule; once you check it, a list similar to the
  1571. one for the not-automatically-tagged messages will be displayed and you
  1572. can change the action for every single message.</para>
  1573. <para>Please note that if there is a message exceeding the size
  1574. limit, but all messages are matched by a filter rule the dialog will
  1575. not be displayed. One exception occurs if you have checked
  1576. <guilabel>Always show matched 'Download Later' messages</guilabel> in
  1577. the <guilabel>Global Options</guilabel> section of the POP filter
  1578. configuration dialog; then, the dialog will also be displayed if you only
  1579. have matched messages, but at least one message was tagged for
  1580. <guilabel>Download later</guilabel>.</para>
  1581. </sect2>
  1582. </sect1>
  1583. <sect1 id="multiple-accounts">
  1584. <title>Using Multiple Accounts</title>
  1585. <para>Multiple accounts are used to check for messages from more than one email address
  1586. and/or mail server. Select <menuchoice><guimenu>Settings</guimenu>
  1587. <guimenuitem>Configure &kmail;...</guimenuitem></menuchoice> and click on the
  1588. <guilabel>Network</guilabel> page to add or change your account settings. See the
  1589. <link linkend="getting-started">Getting started</link> section for more
  1590. information on the settings in the <guilabel>Network</guilabel> page.</para>
  1591. <para>To check for messages from a particular account, use the
  1592. <menuchoice><guimenu>File</guimenu><guimenuitem>Check Mail
  1593. In</guimenuitem></menuchoice> submenu to select the account to check
  1594. for mail. You can also press the mouse button on the <guiicon>Check
  1595. Mail</guiicon> icon for some time to get a list of accounts.</para>
  1596. </sect1>
  1597. <sect1 id="pgp">
  1598. <!-- This section is from Andreas Gungl, 2000-05-21, updated 2002-10-06 by Ingo Kloecker -->
  1599. <title>Signing and Encrypting Messages with <application>PGP</application>
  1600. or <application>GnuPG</application></title>
  1601. <note><para>There have been major changes in the way &kmail; handles
  1602. signing/encryption. The following introduction applies to the previous
  1603. version of &kmail;. You can still read the introduction to get an overview
  1604. about how to sign/encrypt messages, but the details, especially those of
  1605. the configuration, will differ.</para></note>
  1606. <para>This is a short introduction on how to setup &kmail;'s
  1607. <application>PGP</application> (<application>Pretty Good Privacy</application>) support;
  1608. it gives some hints on the use of
  1609. <application>PGP</application> too. It is written for people who are beginners in
  1610. this area; if you are familiar with the use of <application>PGP</application>, you can
  1611. skip most of the steps. This documentation, and the &kmail; user interface,
  1612. generally talk only about <quote>PGP</quote>, but it applies to
  1613. both <application>PGP</application> and <application>GnuPG</application>
  1614. (<application>GNU Privacy Guard</application>),
  1615. (although some <application>GnuPG</application> command-line parameters
  1616. may be different.)</para>
  1617. <para>Please
  1618. also check out the <link linkend="pgp-faq">&FAQ; item about
  1619. <application>PGP</application></link>.</para>
  1620. <warning><para>Attachments will not be signed/encrypted if you are using
  1621. inline OpenPGP: to sign/encrypt attachments, you have to install GnuPG and
  1622. some necessary libraries;
  1623. then, you can decide for each attachment whether it should be signed/encrypted or not.
  1624. </para></warning>
  1625. <warning><para>&kmail; has to rely on <application>PGP</application>'s
  1626. output; this output is often different between different versions of
  1627. <application>PGP</application>, so it is important that you test if encryption
  1628. really works with your setup before you start using it seriously. &kmail; might
  1629. <emphasis>not</emphasis> warn you if something fails -- enable
  1630. <guilabel>Show signed/encrypted text
  1631. after composing</guilabel>. </para></warning>
  1632. <para>To setup and use <application>PGP</application> support in &kmail; it is
  1633. necessary to have <application>PGP</application> installed and set up
  1634. properly; of course, we cannot give you a full introduction of
  1635. <application>PGP</application> here. We will only mention the steps you have to
  1636. do to get <application>PGP</application> going. For details you should have a look at
  1637. the excellent <application>PGP</application> documentation
  1638. or <ulink url="">The GNU Privacy Handbook</ulink>.</para>
  1639. <para>It is certainly a good idea to study this documentation as well as an
  1640. introduction into public key cryptography (&eg; out of the
  1641. <application>PGP</application> 6.5.x package): there you can learn a lot about
  1642. the basic concepts, which will help you to understand what is going on; also,
  1643. many security related issues you should know about are discussed there.</para>
  1644. <para>Now, let us start.</para>
  1645. <sect2 id="pgp-preconditions">
  1646. <title>Preconditions</title>
  1647. <para>&kmail; expects that your <application>PGP</application> binary is called
  1648. <command>pgp</command>; in the case of <application>GnuPG</application>, it expects
  1649. the binary to be called <command>gpg</command>. If this is not the case for you,
  1650. just make a symlink.</para>
  1651. <para>If you have not done so, you have to generate a key pair (secret and public
  1652. key) for your identity. You must do this at the command line: use
  1653. <userinput><command>pgp</command> <option>-kg</option></userinput>
  1654. or <userinput><command>gpg</command> <option>--gen-key</option></userinput>: &kmail;
  1655. has no internal support for <application>pgp</application>'s key generation at
  1656. this time. The identity (normally your name followed by your email address
  1657. within brackets, such as <userinput>John Doe
  1658. &lt;;</userinput>) and your passphrase are important for the
  1659. co-operation between &kmail; and <application>PGP</application>.</para>
  1660. </sect2>
  1661. <sect2 id="pgp-settings">
  1662. <title><application>PGP</application>-Related Settings in &kmail;</title>
  1663. <para>Select the <guilabel>OpenPGP</guilabel> tab on
  1664. the <guilabel>Security</guilabel> settings page; there you will find the
  1665. following options:</para>
  1666. <variablelist>
  1667. <varlistentry>
  1668. <term><guilabel>Encryption tool</guilabel></term>
  1669. <listitem>
  1670. <para>Here you can choose if you want to use <application>PGP</application>,
  1671. <application>GnuPG</application> or no encryption
  1672. software at all; of course, the program you select has to be
  1673. installed on your system (it is also important to select the correct
  1674. version.)</para>
  1675. </listitem>
  1676. </varlistentry>
  1677. <varlistentry>
  1678. <term><guilabel>Keep passphrase in memory</guilabel></term>
  1679. <listitem>
  1680. <para>When this option is off, &kmail; will ask for your passphrase each
  1681. time you sign a message (before sending) or select an encrypted message;
  1682. if you turn this option on, &kmail; will remember your passphrase from
  1683. after your first successful input until you finish your &kmail; session. The
  1684. passphrase is stored in memory and not written to the hard disk.
  1685. If you use one of the Crypto-Plugins or if you use <application>GnuPG</application>
  1686. with the gpg-agent then an external program will ask for your passphrase and
  1687. optionally remember it for some time.</para>
  1688. </listitem>
  1689. </varlistentry>
  1690. <varlistentry>
  1691. <term><guilabel>Always encrypt to self</guilabel></term>
  1692. <listitem>
  1693. <para>If this option is off and you want to send an encrypted message to somebody,
  1694. then you cannot read this message any longer after you have composed and
  1695. encrypted it. Turn this option on to keep sent encrypted messages readable for
  1696. you too.</para>
  1697. </listitem>
  1698. </varlistentry>
  1699. <varlistentry>
  1700. <term><guilabel>Show signed/encrypted text after composing</guilabel></term>
  1701. <listitem>
  1702. <para>This will show you the result of encrypting and signing before the message
  1703. gets sent; this way, you can still cancel sending if encrypting failed. It is
  1704. strongly recommended to use this option.</para>
  1705. </listitem>
  1706. </varlistentry>
  1707. <varlistentry>
  1708. <term><guilabel>Always show the encryption keys for approval</guilabel></term>
  1709. <listitem>
  1710. <para>This will always open a dialog that lets you choose the keys used for
  1711. each recipient when you are sending an encrypted message; if this
  1712. option is off, &kmail; will show this dialog only when it cannot
  1713. find a key for a recipient or when there are conflicting or unset encryption
  1714. preferences.</para>
  1715. </listitem>
  1716. </varlistentry>
  1717. <varlistentry>
  1718. <term><guilabel>Automatically sign messages using OpenPGP</guilabel></term>
  1719. <listitem><para>This lets you toggle whether to automatically sign your messages
  1720. by default; of course, it is still possible to send unsigned messages by deselecting
  1721. the icon in the composer window.</para>
  1722. </listitem>
  1723. </varlistentry>
  1724. <varlistentry>
  1725. <term><guilabel>Automatically encrypt messages whenever possible</guilabel></term>
  1726. <listitem><para>If this option is on, &kmail; will automatically encrypt messages
  1727. with the built-in OpenPGP support or the PGP/MIME-Plugin provided that,
  1728. for every recipient, a trusted PGP key is found in your keyring and
  1729. you did not tell &kmail; not to encrypt messages sent to
  1730. certain recipients. If in doubt, &kmail; will ask whether the message
  1731. should be encrypted or not.</para></listitem>
  1732. </varlistentry>
  1733. </variablelist>
  1734. <para>Now that you have setup the encryption tool you have tell &kmail; which
  1735. OpenPGP key you want to use for signing and for encrypting messages;
  1736. to do this go to the <link linkend="configure-identity">Identities configuration</link>
  1737. and set the key that should be used on the <guilabel>Advanced</guilabel> tab of the
  1738. identity configuration.</para>
  1739. <para>Now you are able to sign outgoing messages; to let people send you
  1740. encrypted messages and to let them verify your signature you
  1741. must send them your public key or upload your public key to a public
  1742. <application>PGP</application> key server so that they can fetch your key from there.
  1743. To send encrypted messages to other people or to verify their signed
  1744. messages you will need their public keys; you can store your public key(s) on a
  1745. public <application>PGP</application> key server such as <ulink
  1746. url=""></ulink>.</para>
  1747. </sect2>
  1748. <sect2 id="pgp-sign-your-messages">
  1749. <title>Sign your Messages</title>
  1750. <para>You can compose your message as usual in the composer
  1751. window of &kmail;. Before you send the message, check the <guiicon>Sign Message</guiicon>
  1752. icon on the toolbar of the composer window; then, you can send
  1753. the message. The identity you are using to write the current message needs to
  1754. be connected to an <guilabel>OpenPGP Key</guilabel> in the <guilabel>Identity</guilabel>
  1755. section of the <guilabel>Configure</guilabel> dialog.
  1756. To sign the message, &kmail; needs to know your <application>PGP</application>
  1757. passphrase: if you did not select <guilabel>Keep passphrase in memory</guilabel> in the
  1758. <guilabel>Security</guilabel> section, &kmail; will ask you for it; otherwise,
  1759. if you have already given the phrase to &kmail;, it will sign the
  1760. message without any further prompt.</para>
  1761. </sect2>
  1762. <sect2 id="pgp-encrypt-your-messages">
  1763. <title>Encrypt your Messages</title>
  1764. <para>To send an encrypted message to somebody of whom you have a
  1765. public key, you simply create the message in the composer window.
  1766. Before you send the message, check the <guibutton>Encrypt
  1767. Message</guibutton> button in the toolbar of the composer window; note
  1768. that you might not have to check the button if <guilabel>Automatically
  1769. encrypt messages whenever possible</guilabel> is selected in
  1770. &kmail;'s configuration (see <link linkend="pgp-sign-your-messages">above</link>).
  1771. Then send the message.</para>
  1772. <para>
  1773. If you checked the <guilabel>Encrypt Message</guilabel> button and &kmail;
  1774. cannot find a matching key for a recipient, it will display a list containing
  1775. all available keys in the <guilabel>Encryption Key Selection</guilabel> dialog;
  1776. if &kmail; finds more than one trusted key for a recipient, it will
  1777. display a list containing all matching keys for this recipient. In both
  1778. cases you can select the key(s) which should be used for encrypting
  1779. this message for the recipient in question.
  1780. Using the <guilabel>Remember choice</guilabel>
  1781. checkbox you can save your selection for future messages.</para>
  1782. <para>If you are using a key for the first time, there are conflicting
  1783. Encryption Preferences, or if <guilabel>Always
  1784. show the encryption keys for approval</guilabel> is selected in the
  1785. <guilabel>Security</guilabel> section of &kmail;'s configuration dialog
  1786. the <guilabel>Encryption Key Approval</guilabel> dialog will appear;
  1787. here, you can select different keys for the recipients and can
  1788. set the <guilabel>Encryption Preference</guilabel> for each recipient.
  1789. The default option, <guilabel>Encrypt whenever encryption is
  1790. possible</guilabel>, will automatically encrypt your message if there is a
  1791. trusted key for each recipient.</para>
  1792. <para>As mentioned above, you will not be able to read your own encrypted sent
  1793. messages if you do not check <guilabel>Always encrypt to self</guilabel> in the
  1794. settings' <guilabel>Security</guilabel> page.</para>
  1795. </sect2>
  1796. <sect2 id="pgp-send-your-public-key">
  1797. <title>Send your Public Key</title>
  1798. <para>Prepare a message to the person to whom you want to send your public key;
  1799. then, choose, in the composer window's menu,
  1800. <menuchoice><guimenu>Attach</guimenu><guimenuitem>Attach My Public
  1801. Key</guimenuitem></menuchoice>: this will attach the public key you
  1802. defined for the current identity to the message. Now you can send the message.</para>
  1803. <para>Remember that it is not safe at all if you sign the message to make sure
  1804. that the receiver will get the correct key: there can be a man-in-the-middle
  1805. attack, as somebody can change the key and sign the message with that other
  1806. key. That is why the recipient should verify the attached key by checking the
  1807. key's fingerprint against the one he received in a secure way from you; have a look
  1808. at the <application>PGP</application> documentation for further details.</para>
  1809. </sect2>
  1810. <sect2 id="pgp-you-received-an-encrypted-message">
  1811. <title>You received an encrypted Message</title>
  1812. <para>All you have to do is to select the message in &kmail;. You will be
  1813. prompted for your passphrase; then, &kmail; will try to decrypt the message and
  1814. show you the plain text if the message had been encrypted with your public
  1815. key: if not, then you will not be able to read it. &kmail; stores the messages
  1816. encrypted, so nobody can read these messages without knowing your passphrase.</para>
  1817. </sect2>
  1818. <sect2 id="pgp-receiving-a-public-key">
  1819. <title>Receiving a Public Key</title>
  1820. <para>You can receive a public key as an attachment or via http, ftp or a floppy.
  1821. Before you can use this key to encrypt a message to the owner of the
  1822. key, you should verify the key (check its fingerprint or look for
  1823. trusted signatures); then, you can add this key to your public keyring
  1824. by typing <userinput><command>pgp</command> <option>-ka</option>
  1825. <replaceable>filename</replaceable></userinput> at the command line (if you are using
  1826. <application>PGP</application>) or by typing
  1827. <userinput><command>gpg</command> <option>--import</option>
  1828. <replaceable>filename</replaceable></userinput> at the command line (if you are using
  1829. <application>GnuPG</application>). If the key is not certified with a trusted signature
  1830. you cannot use it to encrypt messages unless you have signed the key with your key.
  1831. </para>
  1832. </sect2>
  1833. </sect1>
  1834. <sect1 id="the-anti-spam-wizard">
  1835. <title>The Anti-Spam Wizard</title>
  1836. <sect2 id="spam-wizard-basics">
  1837. <title>Basics</title>
  1838. <para>&kmail; does not have a built-in spam detection solution: the developers believe
  1839. using external, but specialized, tools is the better approach. &kmail; uses these tools
  1840. through its flexible filter architecture. The Anti-Spam Wizard helps you with the
  1841. initial filter setup.
  1842. </para>
  1843. <variablelist>
  1844. <varlistentry>
  1845. <term>What can the wizard do to help you?</term>
  1846. <listitem>
  1847. <para>It will give you some choices about how you want the spam filtering to be set up.
  1848. Afterwards it will automatically create the appropriate filter rules.
  1849. </para>
  1850. </listitem>
  1851. </varlistentry>
  1852. <varlistentry>
  1853. <term>What are the limitations of the wizard?</term>
  1854. <listitem>
  1855. <para>It can only initially set up the filters for you; and it will provide a
  1856. standard setup. Manual modifications in existing filters are not considered.
  1857. Instead, these filters are overwritten by the wizard.
  1858. </para>
  1859. </listitem>
  1860. </varlistentry>
  1861. </variablelist>
  1862. <para>You can activate the wizard via <menuchoice><guimenu>Tools</guimenu>
  1863. <guisubmenu>Anti-Spam Wizard...</guisubmenu></menuchoice>.</para>
  1864. <para>The wizard scans for known anti-spam tools on your computer.
  1865. It is as well possible to use results of spam checks made by your provider
  1866. by evaluating some header information which has been added to the messages.
  1867. You can let the wizard prepare &kmail; to use one or many of them in parallel.
  1868. However, note that anti-spam tool operations are usually time consuming.
  1869. &kmail; can appear to be frozen during the scan of the messages for spam,
  1870. you may encounter problems with the responsiveness of &kmail;. Please consider
  1871. deleting the filter rules created by the wizard if the filtering becomes
  1872. too slow for you.
  1873. Here are some recommendations regarding the supported tools:</para>
  1874. <variablelist>
  1875. <varlistentry>
  1876. <term>Bogofilter</term>
  1877. <listitem>
  1878. <para>Bogofilter is a bayesian filter, that means it's spam detection
  1879. relies on an initial training phase. On the other hand, it's a pretty
  1880. fast tool. That's why it is recommended to be used by people which
  1881. primarily want to have a fast spam detection, and which don't worry
  1882. about the little training in the beginning before the detection rate
  1883. increases significantly.
  1884. </para>
  1885. </listitem>
  1886. </varlistentry>
  1887. <varlistentry>
  1888. <term>SpamAssassin</term>
  1889. <listitem>
  1890. <para>SpamAssassin is a pretty complex tool to fight against spam.
  1891. Although it's behavior depends heavily on it's configuration, that
  1892. tool can detect spam quite well without any training. However,
  1893. scanning a message takes a little longer compared to pure bayesian
  1894. filters. Let's say, it's not the tool of choice for people without
  1895. some background information about SpamAssassin's capabilities.
  1896. </para>
  1897. </listitem>
  1898. </varlistentry>
  1899. <varlistentry>
  1900. <term>Annoyance-Filter</term>
  1901. <listitem>
  1902. <para>Perhaps not so often used until distributions pick it up.
  1903. It's clearly a tool for specialists.
  1904. </para>
  1905. </listitem>
  1906. </varlistentry>
  1907. <varlistentry>
  1908. <term>GMX Spam Filter</term>
  1909. <listitem>
  1910. <para>Given that you get your mail via the GMX freemail provider,
  1911. your messages are scanned for spam. The result of that process is
  1912. documented in a special header field of each message. It's possible to
  1913. use the content of this header field to sort out spam. There is no
  1914. slowdown in the filtering if only this tool is used, as the messages
  1915. have already been processed.
  1916. </para>
  1917. </listitem>
  1918. </varlistentry>
  1919. </variablelist>
  1920. </sect2>
  1921. <sect2 id="spam-wizard-advanced">
  1922. <title>Advanced</title>
  1923. <para>Here are the details of how the wizard works: &kmail; can use several
  1924. external tools to detect spam messages; it will try to automatically find
  1925. out which of those tools are installed on your box and will show you these
  1926. tools in a list. The list is ordered by the average speed of the filtering
  1927. process of the tools. You can mark the tools which you want
  1928. to be used by &kmail; to detect spam. Of course, you
  1929. can close the wizard, install a tool, and restart the wizard again.
  1930. </para>
  1931. <para>If you have marked at least one tool, KMail is able to provide filters
  1932. which allow the classification of the messages as spam or not spam. It will
  1933. also provide actions to let you manually classify messages. These actions will
  1934. be available via the menu and via toolbar icons.
  1935. If any of the tools you selected support Bayesian filtering (&ie; a method
  1936. to detect spam based on statistical analysis of the messages) then these
  1937. messages are not only marked but additionally transfered to the tools to
  1938. let them learn so they can improve their detection rate.
  1939. </para>
  1940. <para>On the second page, there you will be able to select some additional
  1941. actions to be done in &kmail; with regard to spam messages: if you
  1942. want messages detected as spam to be moved into a certain folder, please select
  1943. the appropriate folder and mark the <guilabel>Move known spam to:</guilabel>
  1944. option; if messages detected as spam should additionally be marked as read,
  1945. then mark the <guilabel>Mark detected spam messages as read</guilabel> option.
  1946. </para>
  1947. <para>Having checked at least one of the available tools will allow you to
  1948. let the wizard finish the filter setup. The wizard will not take any
  1949. modifications in existing filters formerly created by the wizard into
  1950. consideration but will either append new filters or replace existing filters
  1951. in any case; you may want to inspect the result of this process in the
  1952. <link linkend="filter-dialog">Filter Dialog</link>.
  1953. The wizard will also create toolbar buttons for marking messages as spam or
  1954. as ham; keep in mind that classifying messages as spam will also move those
  1955. messages to the folder you had specified for spam messages, if you haven't
  1956. deselected the appropriate option.
  1957. </para>
  1958. </sect2>
  1959. <sect2 id="spam-wizard-details">
  1960. <title>Some More Details for Experts</title>
  1961. <para>The wizard uses information stored in a special configuration file named
  1962. <filename>kmail.antispamrc</filename> (stored in the global or local KDE
  1963. config directory). It will first check the global config file and then the local
  1964. config file: if the local config file contains entries with higher (newer)
  1965. version numbers per-tool the configuration data from the local file for that
  1966. tool is used; that way, both administrators and users can update the
  1967. wizard configuration.
  1968. </para>
  1969. <para>The local detection of spam messages is achieved by creating
  1970. <guilabel>pipe through</guilabel> actions per-tool within a
  1971. special filter. Another filter contains rules to check for detected spam
  1972. messages and actions to mark them and (optionally, depending on the choice
  1973. in the wizard) to move them into a folder. Both filters are configured to
  1974. be applied on incoming messages and on manual filtering.
  1975. </para>
  1976. <para>Two filters are needed for the classification of ham and spam. They
  1977. contain actions to mark the messages appropriately. As mentioned above, the filter
  1978. for classification as spam can have another action to move the message into a
  1979. predefined folder. If the selected tools support Bayesian filtering,
  1980. the wizard will create additional filter actions to pass the messages to the
  1981. tools (via <guilabel>execute command</guilabel> actions) in the
  1982. appropriate learn mode.
  1983. </para>
  1984. <para>If you want to fine-tune the filtering process, you might be interested in the
  1985. chapter about <link linkend="filter-optimization">Filter Optimization</link>.</para>
  1986. </sect2>
  1987. </sect1>
  1988. <sect1 id="the-anti-virus-wizard">
  1989. <title>The Anti-Virus Wizard</title>
  1990. <sect2 id="virus-wizard-basics">
  1991. <title>Basics</title>
  1992. <para>&kmail; does not have a built-in virus detection solution: the developers believe
  1993. using external, but specialized, tools is the better approach. &kmail; uses these tools
  1994. through its flexible filter architecture. The Anti-Virus Wizard helps you with the
  1995. initial filter setup.
  1996. </para>
  1997. <variablelist>
  1998. <varlistentry>
  1999. <term>What can the wizard do to help you?</term>
  2000. <listitem>
  2001. <para>It will give you some choices about how you want virus filtering to be set up.
  2002. Afterwards it will automatically create the appropriate filter rules.
  2003. </para>
  2004. </listitem>
  2005. </varlistentry>
  2006. <varlistentry>
  2007. <term>What are the limitations of the wizard?</term>
  2008. <listitem>
  2009. <para>It can only initially set up the filters for you; and it will provide a
  2010. standard setup. Modifying existing filters is not yet possible.
  2011. </para>
  2012. </listitem>
  2013. </varlistentry>
  2014. </variablelist>
  2015. <para>You can activate the wizard via <menuchoice><guimenu>Tools</guimenu>
  2016. <guisubmenu>Anti-Virus Wizard...</guisubmenu></menuchoice>.</para>
  2017. </sect2>
  2018. <sect2 id="virus-wizard-advanced">
  2019. <title>Advanced</title>
  2020. <para>The Anti-Virus Wizard basically works exactly as the
  2021. <link linkend="the-anti-spam-wizard">Anti-Spam Wizard</link>.
  2022. Here are the details of how the wizard works: &kmail; can use several
  2023. external tools to detect messages containing viruses; it will try to automatically find
  2024. out which of those tools are installed on your box and will show you the
  2025. result of the search for each tool. You can mark the tools which you want
  2026. to be used by &kmail; to detect viruses; marking tools which were not found is
  2027. not possible because the appropriate checkboxes are disabled. Of course, you
  2028. can close the wizard, install a tool, and restart the wizard again.
  2029. </para>
  2030. <para>If you have marked at least one tool you will be able to select some actions
  2031. to be done in &kmail; with regard to messages containing viruses: to let &kmail; detect
  2032. messages containing viruses you definitely should mark the <guilabel>Check messages using the
  2033. anti-virus tools</guilabel> option; if you want messages detected as
  2034. virus-infected to be moved into a certain folder, please select the appropriate folder and
  2035. mark the <guilabel>Move detected viral messages to the selected folder</guilabel>
  2036. option; if messages detected as virus-infected should additionally be marked as read,
  2037. then mark the <guilabel>Additionally, mark detected viral messages as read</guilabel> option.
  2038. </para>
  2039. <para>Having checked at least one of these last options will allow you to
  2040. let the wizard finish the filter setup. The wizard will not take any existing
  2041. filter rules into consideration but will append new rules in any case; you
  2042. may want to inspect the result of this process in the
  2043. <link linkend="filter-dialog">Filter Dialog</link>.
  2044. </para>
  2045. </sect2>
  2046. <sect2 id="virus-wizard-details">
  2047. <title>Details</title>
  2048. <para>The wizard uses information stored in a special configuration file named
  2049. <filename>kmail.antivirusrc</filename> (stored in the global or local KDE
  2050. config directory). It will first check the global config file and then the local
  2051. config file: if the local config file contains entries with higher (newer)
  2052. version numbers per-tool the configuration data from the local file for that
  2053. tool is used; that way, both administrators and users can update the
  2054. wizard configuration.
  2055. </para>
  2056. <para>The detection of messages containing viruses is achieved by creating
  2057. <guilabel>pipe through</guilabel> actions per-tool within a
  2058. special filter. Another filter contains rules to check for detected viral
  2059. messages and actions to mark them and (optionally, depending on the choice
  2060. in the wizard) to move them into a folder. Both filters are configured to
  2061. be applied on incoming messages and on manual filtering.
  2062. </para>
  2063. </sect2>
  2064. </sect1>
  2065. </chapter>