using-kmail.docbook 123 KB
Newer Older
1 2 3 4 5
<chapter id="using-kmail">

<chapterinfo>
<authorgroup>
<author>
6
&Daniel.Naber;
7 8 9
&Daniel.Naber.mail;
</author>
<author>
10
&Scarlett.Clark;
11 12
&Scarlett.Clark.mail;
</author>
13 14 15 16
<author>
&David.Bryant;
&David.Bryant.mail;
</author>
17 18
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
19

20
<date>2020-09-12</date>
21
<releaseinfo>5.14.2 (Applications 20.04.2)</releaseinfo>
22 23 24 25 26 27 28 29 30 31 32 33
</chapterinfo>

<title>Using &kmail;</title>

<sect1 id="the-mail-reader-window">
<title>The Main Window</title>

<para>The main window is the window that appears
when &kmail; is started. It is by default divided into three panes:</para>

<variablelist>
<varlistentry>
34
<term>Folder List (on the left)</term>
35 36 37 38 39 40 41 42 43 44 45
<listitem>
  <screenshot>
<screeninfo>Folder Pane</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="folder-example.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Folder Pane</phrase>
    </textobject>
    <caption>
46
      <para>The Folder List</para>
47 48 49
    </caption>
  </mediaobject>
</screenshot>
50
<para>&nbsp;</para> <!-- whitespace -->
51 52 53

<para>This pane contains the list of your message folders (other email programs
may call them mailboxes). To select a folder, simply click on
54
it. The message header information contained in the folder will then appear in the Message List
55 56
pane. The folder list can be displayed in both a short view, which takes up only
a small portion of the left side of the screen, and a long view, which takes up the 
57 58
entire left side of the screen (and can show more folders). You can toggle
between these two views by using the <guilabel>Appearance</guilabel>/<guilabel>Layout</guilabel> tab
59
in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
60 61 62 63
&kmail;...</guimenuitem></menuchoice> dialog. The top section of the folder pane provides quick links
to your favorite folders. Drag and drop folders here, or add them via the &RMB; context menu item <guimenuitem>Add Favorite Folder</guimenuitem>.
Please see the <link linkend="folders">Folders Section</link> for more details about folders.</para>
<para>&nbsp;</para> <!-- whitespace -->
64 65
</listitem>
</varlistentry>
66

67
<varlistentry>
68
<term>Message List (on the upper right by default)</term>
69 70
<listitem>
<screenshot>
71
<screeninfo>The Message List</screeninfo>
72 73 74 75 76
  <mediaobject>
    <imageobject>
      <imagedata fileref="message.png" format="PNG"/>
    </imageobject>
    <textobject>
77
      <phrase>The Message List</phrase>
78 79
    </textobject>
    <caption>
80
      <para>The Message List (Smart Theme)</para>
81 82 83
    </caption>
  </mediaobject>
</screenshot>
84 85 86 87 88 89 90
<para>&nbsp;</para> <!-- whitespace -->
<para>This pane lists header information (Subject, Sender, and Date)
for the messages in the currently selected folder. Clicking on an item in the Message List
will select that message and display it in the Preview pane; you can also select
more than one message by holding down the &Ctrl; key (or the &Shift; key) when clicking on messages.</para>

<para>Change the appearance of your message list by selecting <menuchoice><guimenu>View</guimenu><guimenuitem>Message List</guimenuitem>
91 92 93
<guimenuitem>Theme</guimenuitem></menuchoice>. You have several options here.
</para>
<itemizedlist>
94 95 96 97
  <listitem><para><guilabel>Classic</guilabel> A simple, backward compatible single row with clickable sort columns.</para></listitem>
  <listitem><para><guilabel>Smart</guilabel> A smart multi-line, multi-item list with status icons, and no sort columns.</para></listitem>
  <listitem><para><guilabel>Smart with Clickable Status</guilabel> A smart multi-line, multi-item list with clickable status icons.</para></listitem>
  <listitem><para><guilabel>Configure...</guilabel> Allows you to customize your own Message List Theme (&eg; add or remove columns from the clickable sort bar.)</para></listitem>
98 99
</itemizedlist>
<para>
100 101 102 103
If you have chosen the Classic theme, you may sort the messages by clicking on the column that you wish to sort;
if you click on the same column again, the sort order will toggle between ascending/descending. Clicking the &RMB; on the list header shows a pop up menu,
which allows you to show or hide several columns in the list. You can customize the columns visible on the sort bar;
see <link linkend="customize-messagelist-theme">Configure Appearance of Message List</link> for details.
104
</para>
105
<para>&nbsp;</para> <!-- whitespace -->
106 107 108
</listitem>
</varlistentry>
<varlistentry id="using-message-preview-pane">
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
<term>Preview Pane (in the lower right by default)</term>
<listitem>
<screenshot>
<screeninfo>The Message Preview Pane</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="preview.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>The Message Preview Pane</phrase>
    </textobject>
    <caption>
      <para>The Preview Pane</para>
    </caption>
  </mediaobject>
</screenshot>
<para>&nbsp;</para> <!-- whitespace -->
<para>This pane displays the currently selected message. Here are some ways to adjust the Preview pane.</para>
<para>The top of the Preview pane displays the message headers. Several display options are available. Go to 
<menuchoice><guimenu>View</guimenu><guisubmenu>Headers</guisubmenu></menuchoice>
and try them out until you find one you like!</para>
130
<itemizedlist id="using-header-options">
131 132 133 134
  <listitem><para><guilabel>Fancy Headers</guilabel> Colorful header with a spam status / attachments notification.</para></listitem>
  <listitem><para><guilabel>Brief Headers</guilabel> Title, and in parentheses: From, CCs (if any), and the date.</para></listitem>
  <listitem><para><guilabel>&kmail; 5.2</guilabel> An avatar (if available) with Title, From, To, CCs (if any), and spam status
    / attachments on separate lines.</para></listitem>
135 136
  <listitem><para><guilabel>Download New Themes...</guilabel> Allows you to download custom themes created by other &kmail; users.</para></listitem>
</itemizedlist>
137 138 139 140 141 142 143
<para>Click on the bar located on the left hand side of the pane to toggle between plain text and &HTML; (if the message is coded both ways).
The text on the bar will inform you which view you are in. The <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&kmail;...</guimenuitem><guisubmenu>Security</guisubmenu></menuchoice> dialog allows you to select HTML as the default message
display option, if you prefer &HTML; to plain text.</para>
<para>If you would like to change the way your attachments appear in your messages, go to <menuchoice><guimenu>View</guimenu>
<guisubmenu>Attachments</guisubmenu></menuchoice>.
These are your options.</para>
144 145 146
<itemizedlist id="using-attachment-view-options">
  <listitem><para><guimenuitem>As Icons</guimenuitem>, all attachments appear as icons at the bottom of the message.</para></listitem>
  <listitem><para><guimenuitem>Smart</guimenuitem> will show attachments as icons, unless the message suggests that they should be displayed inline.
147 148
    You can suggest that certain attachments should be shown inline in messages you compose by selecting <guilabel>Suggest automatic display</guilabel>
    in <link linkend="the-composer-window">the composer window</link> via the attachment's properties dialog.</para></listitem>
149
  <listitem><para><guimenuitem>Inline</guimenuitem> shows the contents of the attachments at the bottom of the message.
150
    Attachments that cannot be displayed, &eg; compressed files, will still be shown as an icon.</para></listitem>
151
  <listitem><para><guimenuitem>Hide</guimenuitem> will not show attachments.</para></listitem>
152 153
  <listitem><para><guimenuitem>In Header Only</guimenuitem> will suppress inline displays, but list the attachments along with
    the message headers.</para></listitem>
154
</itemizedlist>
155 156 157 158 159 160 161 162 163 164 165
<para>The interactions among the header themes, the attachment views, and the plain text versus &HTML; preferences is rather complex.
For example, if you attach an HTML file to a plain text message, &kmail; will probably interpret your message as being coded in two
different formats, even though this is not really the case. Similarly, &HTML; messages may display embedded images even when you have
selected the "Hide" option for attachments.</para>

<para>The structure of each message can be displayed by pressing <keycombo 
  action="simul">&Ctrl;&Alt;<keycap>D</keycap></keycombo>. This will open a message structure viewer below the preview pane.
  Turn the message structure viewer off by pressing the same three keys.</para>

<para>You can scroll through the message page-by-page using the &PgUp; and &PgDn; keys, or line-by-line using the
&Up; and &Down; keys; you can also use <link linkend="keyboard-shortcuts">keyboard shortcuts</link>
166 167 168 169 170 171 172 173 174
to skip through your messages without having to use the mouse.</para></listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="keyboard-shortcuts">
<title>Keyboard Shortcuts</title>

175 176 177 178
<para>The following keyboard shortcuts are supported by default in the main window. Notice that
many "universal" shortcuts (&eg; <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> to
copy selected text to the clipboard, or <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
to open a "Find" dialog) are recognized by &kmail;, but are not documented here.</para>
179 180 181 182 183 184 185 186 187 188 189

<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Keyboard Shortcut</entry>
<entry>Action</entry>
</row>
</thead>
<tbody>
<row>
190 191
<entry>&Space;</entry>
<entry>Scroll down in the current message.</entry>
192 193
</row>
<row>
194
<entry><keycap>→</keycap> or <keycap>N</keycap></entry>
195 196 197
<entry>Go to the next message in the current folder and display the message preview.</entry>
</row>
<row>
198
<entry><keycap>←</keycap> or <keycap>P</keycap></entry>
199 200 201
<entry>Go to the previous message in the current folder and display the message preview.</entry>
</row>
<row>
202 203
<entry><keycombo action="simul">&Ctrl;&Home;</keycombo></entry>
<entry>Go to the very first message in the current folder and display the message preview.</entry>
204 205
</row>
<row>
206 207
<entry><keycombo action="simul">&Ctrl;&End;</keycombo></entry>
<entry>Go to the very last message in the current folder and display the message preview.</entry>
208 209 210 211 212 213 214 215 216 217
</row>
<row>
<entry><keycap>+</keycap></entry>
<entry>Go to the next unread message in the current folder.</entry>
</row>
<row>
<entry><keycap>-</keycap></entry>
<entry>Go to the previous unread message in the current folder.</entry>
</row>
<row>
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
<entry><keycap>C</keycap></entry>
<entry>Copy this message to another folder.</entry>
</row>
<row>
<entry><keycap>M</keycap></entry>
<entry>Move this message to another folder.</entry>
</row>
<row>
<entry><keycap>A</keycap></entry>
<entry>Reply to all recipients of this message (with quote).</entry>
</row>
<row>
<entry><keycap>R</keycap></entry>
<entry>Reply to sender with quote.</entry>
</row>
<row>
<entry><keycombo action="simul">&Shift;<keycap>R</keycap></keycombo></entry>
<entry>Reply to sender without quoting anything.</entry>
</row>
<row>
<entry><keycap>S</keycap></entry>
<entry>Launch the message search dialog.</entry>
</row>
<row>
<entry><keycap>T</keycap></entry>
<entry>Open this message in the composition window.</entry>
</row>
<row>
<entry>&Enter;</entry>
<entry>View selected message in the full-screen message viewer.</entry>
</row>
<row>
<entry><keycap>V</keycap></entry>
<entry>View the raw message, headers and all, as a text file.</entry>
</row>
<row>
<entry><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></entry>
<entry>Check for new messages on the server(s).</entry>
</row>
<row>
<entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
<entry>Open the composition window to write a new message.</entry>
</row>
<row>
262
<entry><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></entry>
263
<entry>Zoom in on the current message, in increments of 20%.</entry>
264 265 266
</row>
<row>
<entry><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></entry>
267
<entry>Zoom out of the current message, in increments of 20%.</entry>
268 269
</row>
<row>
270 271
<entry><keycombo action="simul">&Ctrl;<keycap>0</keycap></keycombo></entry>
<entry>Reset message Zoom factor to 100% (full size).</entry>
272 273
</row>
<row>
274 275
<entry><keycombo action="simul">&Ctrl;&Alt;<keycap>D</keycap></keycombo></entry>
<entry>Toggle message structure display (below the message preview pane).</entry>
276 277
</row>
<row>
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
<entry><keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo></entry>
<entry>Create the tabbing toolbar (appears above the message list).</entry>
</row>
<row>
<entry><keycombo action="simul">&Ctrl;&Shift;<keycap>W</keycap></keycombo></entry>
<entry>Remove the currently active tab from the tabbing toolbar.</entry>
</row>
<row>
<entry><keycombo action="simul">&Alt;<keycap>↑</keycap></keycombo></entry>
<entry>Go to the previous folder in the folder list (if the folder list has focus).</entry>
</row>
<row>
<entry><keycombo action="simul">&Alt;<keycap>↓</keycap></keycombo></entry>
<entry>Go to the next folder in the folder list (if the folder list has focus).</entry>
</row>
<row>
<entry><keycombo action="simul">&Ctrl;&Home;</keycombo></entry>
<entry>Focus on the very first folder. Use
<keycombo action="simul">&Ctrl;&Space;</keycombo> to actually
297 298 299
enter the folder.</entry>
</row>
<row>
300 301 302
<entry><keycombo action="simul">&Ctrl;&End;</keycombo></entry>
<entry>Focus on the very last folder. Use
<keycombo action="simul">&Ctrl;&Space;</keycombo> to actually
303 304 305
enter the folder.</entry>
</row>
<row>
306
<entry><keycombo action="simul">&Ctrl;&Space;</keycombo></entry>
307
<entry>Enter the folder that has focus, &ie; the folder that you navigated
308 309
to using <keycombo action="simul">&Ctrl;&Home;</keycombo> or
<keycombo action="simul">&Ctrl;&End;</keycombo>.</entry>
310 311
</row>
<row>
312 313 314 315 316 317 318 319
<entry><keycombo action="simul">&Shift;<keycap>H</keycap></keycombo></entry>
<entry>Toggle between plain text and &HTML; (unless &HTML; has been preferred 
via the <guilabel>Settings</guilabel> dialog).</entry>
</row>
<row>    
<entry><keycombo action="simul">&Shift;<keycap>←</keycap></keycombo> &amp;
<keycombo action="simul">&Shift;<keycap>→</keycap></keycombo></entry>
<entry>Select messages sequentially in the message list, starting with the current message.</entry>
320 321 322 323 324
</row>
</tbody>
</tgroup>
</informaltable>

325 326 327 328 329 330 331 332 333
<para>For more keyboard shortcuts, take a look at the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
Shortcuts...</guimenuitem></menuchoice> dialog. If you're not happy with the defaults, you can change them!</para>

<para>Two mouse actions deserve mention here. First, you can select multiple noncontiguous messages to be processed
all at once (&eg; copied, deleted, or moved) by pressing &Ctrl; and selecting them with the &LMB;. Second, you
can open a message in an external window by double-clicking an item in the message list. If the message is in 
the outbox, drafts, or templates folder, it will be opened in a composition window. Otherwise, it will be opened
with the external message viewer, an abbreviated version of &kmail;'s main window without the folder and 
message lists, and with shorter menus.</para>
334 335 336 337 338

</sect1>

<sect1 id="the-composer-window">
<title>The Composer Window</title>
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
<screenshot>
<screeninfo>Composer Window</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="composer-window.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Composer Window</phrase>
    </textobject>
    <caption>
      <para>The Composer Window in &HTML; composition mode.</para>
    </caption>
  </mediaobject>
</screenshot>
<para>&nbsp;</para> <!-- whitespace -->
<para>The composer window is used to write new messages, to compose replies, and to forward messages.
  It can be opened in several ways. Here are the various options for composing messages.</para>
356 357 358 359 360
<sect2 id="composing-a-message">
<title>Composing a Message</title>
<variablelist>
  <varlistentry id="compose-new-message"><term>New Message...</term>
  <listitem>
361
  <para>The New Message composer window can be invoked in four different ways:</para>
362 363 364 365 366 367 368 369
      <itemizedlist>
        <listitem>
          <para><menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>New Message...</guimenuitem></menuchoice></para>
        </listitem>
        <listitem>
          <para><menuchoice><guimenu>Message</guimenu><guimenuitem>New Message...</guimenuitem></menuchoice></para>
        </listitem>
        <listitem>
370 371 372 373 374
          <para>Via the <guiicon><inlinemediaobject><imageobject><imagedata fileref="mail-message-new.png" format="PNG"/>
          </imageobject></inlinemediaobject> New</guiicon> icon on the main toolbar.</para>
        </listitem>
        <listitem>
          <para>Via the keyboard shortcut <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>.</para>
375 376 377 378
        </listitem>
      </itemizedlist>
      <para>To write your message, fill in the appropriate fields in the
        composer window. Use the <guimenu>View</guimenu> menu
379 380
        to select which header fields are displayed. Any selection you make will remain as the
        default when you open a new composer window. These items are available.</para>
381 382
      <itemizedlist id="composer-headers">
        <listitem>
383
          <para>The <guimenuitem>Identity</guimenuitem> drop down box lets you select an identity to use.</para>
384 385
        </listitem>
        <listitem>
386
          <para>The <guimenuitem>Dictionary</guimenuitem> drop down box lets you choose a dictionary for spell checking.</para>
387 388
        </listitem>
        <listitem>
389
          <para><guimenuitem>Sent-Mail Folder</guimenuitem> lets you specify where a local copy of this message will be saved when you send it.</para>
390 391
        </listitem>
        <listitem>
392
          <para><guimenuitem>Mail Transport</guimenuitem> lets you select an outgoing mail server.</para>
393 394
        </listitem>
        <listitem>
395 396 397 398
          <para>The traditional From:, To:, and Subject: fields. (The Reply To: field will appear only if you have
            specified an alternative <guilabel>Reply To</guilabel> address on the <guilabel>Advanced</guilabel> tab
            in the <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure &kmail;...</guisubmenu>
            <guisubmenu>Accounts</guisubmenu><guimenuitem>Identities</guimenuitem></menuchoice> dialog.)</para>
399 400
        </listitem>
        <listitem>
401
          <para><guimenuitem>Use Fixed Font</guimenuitem> toggles fixed width fonts on and off.</para>
402 403
        </listitem>
        <listitem>
404
          <para><guimenuitem>Snippets</guimenuitem> displays the snippets window, where you may save frequently used bits of verbiage.</para>
405 406 407
        </listitem>
      </itemizedlist>

408 409
<para>There are a variety of shortcuts to help
you write messages. The <guibutton>Select...</guibutton> button next to
410
the <guilabel>To:</guilabel>, <guilabel>CC:</guilabel>, and
411 412
<guilabel>BCC:</guilabel> fields opens a list from &kaddressbook; so you can
select one or more recipients.</para>
413

414
<para>Alternatively, when you start typing an address in the
415
<guilabel>To:</guilabel>/<guilabel>CC:</guilabel>/<guilabel>BCC:</guilabel>
416 417 418 419 420
fields, a popup will appear that suggests similar recently used addresses
and closely matching addresses from &kaddressbook;; if you do not like this automatic 
popup, you can disable it by clicking the &RMB; in the field where you're typing, then choosing 
a different <guilabel>Text Completion &gt;</guilabel> mode. You can also use this context menu to fine-tune the
order in which suggested completions appear (via <guilabel>Configure Completion...</guilabel>).</para>
421 422

<para>Whenever you want to add more than one
423
recipient in one of the fields, use a comma to separate one address
424 425
from the next one. 
<!-- fixme: there's now a setting for this: -->
426
You may have to specify fully qualified addresses
427 428 429
(&ie; <userinput>user@example.com</userinput>) even for local
users, depending on your system configuration.</para>

430 431 432 433 434 435 436 437
<para>When you are finished with your message, click the <guiicon><inlinemediaobject><imageobject>
<imagedata fileref="mail-send.png" format="PNG"/></imageobject></inlinemediaobject> Send</guiicon> icon to send the message now,
or click the <guiicon><inlinemediaobject><imageobject><imagedata fileref="mail-queue.png" format="PNG"/></imageobject>
</inlinemediaobject> Queue</guiicon> icon to put the message in the outbox.
If your message is not finished yet, select <menuchoice><guimenu>Message</guimenu><guimenuitem>Save as Draft</guimenuitem></menuchoice>
to save it for later editing.
If you want to print your message, select <menuchoice><guimenu>Message</guimenu><guimenuitem>Print Preview</guimenuitem></menuchoice>
to preview the message, and <menuchoice><guimenu>Message</guimenu><guimenuitem>Print</guimenuitem></menuchoice> to print it.</para>
438
  <para id="send-later"><menuchoice><guimenu>Message</guimenu><guimenuitem>Send Later</guimenuitem></menuchoice>
439 440 441
    lets you schedule your emails to be sent at a specific date and time. Please see 
    <ulink url="help:/akonadi_sendlater_agent">Send Later Agent</ulink> for details.</para>
<para>&nbsp;</para> <!-- whitespace -->
442 443
</listitem>
</varlistentry>
444 445 446
<varlistentry id="new-compose-from-templates">
    <term><menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guisubmenu>Message From Template</guisubmenu>
    <guimenuitem><replaceable>My Super Template</replaceable></guimenuitem></menuchoice></term>
447
  <listitem>
448 449 450 451 452 453 454
    <para>Composing a new message from a template is useful when you have created a masterpiece
    that you would like to use as a template for future new messages.
    Select <menuchoice><guimenu>Message</guimenu><guimenuitem>Save as Template</guimenuitem></menuchoice>; this will place your new template in
    the <guilabel>templates</guilabel> folder. You can revise the template at any time by selecting it from this folder.
    Double click on the template's name (or press the shortcut key, <keycap>T</keycap>) to open it in a composition window.
    You may also select the template via the <guimenu>File</guimenu> menu, as shown above.</para>
  <para>&nbsp;</para> <!-- whitespace -->
455 456 457 458 459 460 461 462 463
  </listitem>
</varlistentry>
</variablelist>
</sect2>

<sect2 id="encrypt-sign">
<title>Signing and Encrypting Messages</title>

<para>
464
If you want to send an <link linkend="pgp-encrypt-your-messages">encrypted</link>
465
or <link linkend="pgp-sign-your-messages">digitally signed</link> message, select the
466 467 468 469 470
<guiicon>Sign</guiicon> and / or <guiicon>Encrypt</guiicon> icon in the toolbar.
Use the <menuchoice><guimenuitem>Options</guimenuitem><guisubmenu>Cryptographic Message
Format &gt;</guisubmenu></menuchoice> dropdown list to select the format used to encrypt the 
message. (The <guilabel>Optons</guilabel> menu also lets you sign / encrypt the message.)
You may choose one of five formatting options.
471 472 473 474 475 476 477
</para>

<variablelist id="cryptographic-message-formats">
<varlistentry>
<term><guilabel>Any</guilabel></term>
<listitem>
<para>&kmail; will use a format which is understood by all recipients of the
478 479
message. The preferred format for each recipient can be specified via 
<ulink url="help:/kaddressbook">&kaddressbook;</ulink>.</para></listitem>
480 481 482 483
</varlistentry>
<varlistentry>
<term><guilabel>Inline OpenPGP (deprecated)</guilabel></term>
<listitem>
484
<para>This format is deprecated, but is supported for backward compatibility. If you use this format then only the
485 486 487
message text will be signed and/or encrypted. <emphasis>Attachments will 
neither be signed nor encrypted.</emphasis> &HTML; messages cannot be signed
with this format. You should only use this format
488
when necessary, &ie; if you send messages to people who use email clients that cannot
489 490 491 492 493
handle the more advanced formats.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>OpenPGP/&MIME;</guilabel></term>
<listitem>
494
<para>This format is the successor to the inline OpenPGP format. If you
495 496
use this format then the message text and all attachments will be signed
and/or encrypted (at least by default). This is the recommended format if you
497
use OpenPGP encryption.</para></listitem>
498 499 500 501 502 503 504
</varlistentry>
<varlistentry>
<term><guilabel>S/&MIME;</guilabel></term>
<listitem>
<para>This format is an alternative format to OpenPGP/&MIME;. If you
use this format then the message text and all attachments will be signed
and/or encrypted (at least by default). This format is mostly used by
505
corporations. It relies on an x.509 certificate, not a PGP / GPG key.</para></listitem>
506 507 508 509
</varlistentry>
<varlistentry>
<term><guilabel>S/&MIME; opaque</guilabel></term>
<listitem>
510 511
<para>This format is a variant of the S/&MIME; format. Because it rolls the message, any attachments,
and the digital signature into a single &MIME; object, it is cpu-intensive and should only be
512 513 514
used if necessary.</para></listitem>
</varlistentry>
</variablelist>
515
<para>&nbsp;</para> <!-- whitespace -->
516 517 518 519 520 521
</sect2>

<sect2 id="html-mails">
<title>Creating &HTML; Messages</title>

<para>Note that &HTML; messages are often regarded as an annoyance; therefore,
522 523
you should use &HTML; messages judiciously. In particular, you should never
send &HTML; messages to mailing list recipients unless &HTML; messages are explicitly
524 525
allowed.</para>

526 527 528 529 530 531 532 533 534 535 536 537 538 539
<para>To create &HTML; messages, you must first enable
the markup tools. To do this, enable <guimenuitem>Rich Text Editing</guimenuitem>
in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu, or click on
the <guiicon>Rich Text</guiicon> icon on the &kmail; toolbar. A toolbar with several
formatting tools will appear. Via the &HTML; toolbar you can choose
standard text or bulleted / numbered lists. (Use the <guilabel>None <inlinemediaobject><imageobject>
<imagedata fileref="go-down.png" format="PNG"/></imageobject></inlinemediaobject></guilabel>
drop-down list at the left edge of the toolbar to control the style of bulleted / numbered lists.)
You can also control the font family, the font size, the font style (bold,
italic, underlined, or strike-through) and the text / background color. And you can specify
the alignment of the text (left aligned, centered, right aligned, or justified) and
insert anchor tags (aka links), horizontal lines, images, tables, and arbitrary &HTML; code
(although support for some of the more advanced &HTML; tags is still incomplete).</para>
<para>&nbsp;</para> <!-- whitespace -->
540 541 542 543 544
</sect2>

<sect2 id="attachments">
<title>Adding Attachments</title>

545
<para>You can attach files to your message by using any of these methods.</para>
546 547 548

<itemizedlist>
<listitem>
549 550 551 552 553 554
<para>Use the <menuchoice><guimenu>Attach</guimenu><guisubmenu>Attach
&gt;</guisubmenu></menuchoice> dropdown list and ensuing dialog to choose a file;</para>
</listitem>
<listitem>
<para>Click the <guiicon><inlinemediaobject><imageobject><imagedata fileref="mail-attachment.png" format="PNG"/>
</imageobject></inlinemediaobject> Attach </guiicon> icon and select the file you wish to attach;</para>
555 556 557 558 559 560 561
</listitem>
<listitem>
<para>Drag a file from the desktop or another folder into the
composer window;</para> 
</listitem>
<listitem>
<para>Drag a message from &kmail;'s message list into the composer
562
window – that message will then be attached;</para>
563 564
</listitem>
<listitem>
565 566
<para>Select one of the additional options in the
<menuchoice><guimenu>Attach</guimenu></menuchoice> menu; or</para>
567 568
</listitem>
<listitem>
569 570 571 572
<para> Select <menuchoice><guimenu>Message</guimenu><guimenuitem><inlinemediaobject><imageobject>
<imagedata fileref="document-open.png" format="PNG"/></imageobject></inlinemediaobject> Insert Text File ...</guimenuitem></menuchoice>
or <menuchoice><guimenu>Message</guimenu><guimenuitem><inlinemediaobject><imageobject><imagedata fileref="document-open.png" format="PNG"/>
</imageobject></inlinemediaobject> Insert Recent Text File  &gt;</guimenuitem></menuchoice>.</para>
573 574 575 576 577
</listitem>
</itemizedlist>

<para>Once a file is attached to your message, it appears in the attachments
pane at the bottom of the composer window. You can use the
578 579 580 581 582 583 584 585 586
&RMB; on each attachment to <guimenuitem>View</guimenuitem>, <guimenuitem>Open</guimenuitem>,
<guimenuitem>Edit</guimenuitem>, <guimenuitem>Reload</guimenuitem>,
<guimenuitem>Save As...</guimenuitem>, or <guimenuitem>Remove</guimenuitem> the
attachment. (This context menu varies a little, depending on the file type of the
attachment.) Several options (Compress / Encrypt / Sign / Suggest Automatic Display) may
be toggled on or off for each file attached to a message.</para>

<para>Use the <guimenuitem>Properties</guimenuitem> item in the context menu to
open the <guilabel>Attachment Properties</guilabel> dialog.
587
The first field contains the attachment's &MIME; type. Just like the <guilabel>Name</guilabel>
588 589
field, it is automatically filled with an appropriate value. Sometimes the
&MIME; type may be wrong. You can then type in any &MIME; type or
590 591 592
choose from the list of common &MIME; types. You can also select an encoding
method for your file from the list of encoding options (normally, the default
value works fine). Check the <guilabel>Suggest automatic display</guilabel> option 
593 594
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,
595 596
and on his settings.</para>

597
<para>You can also attach public crypto keys to the message by choosing the appropriate options in the
598
<menuchoice><guimenu>Attach</guimenu></menuchoice> menu. <application>GnuPG</application>
599
keys and x.509 certificates are (usually) handled as file attachments.</para>
600 601 602 603 604 605

</sect2>

<sect2 id="checking-the-spelling-of-your-message">
<title>Checking the Spelling of your Message</title>

606 607
<para>&kmail; can automatically check the spelling of your message
and underline unknown words in red. If there are too many
608
unknown words &kmail; will disable its checking. To select the language
609
used when checking, select <menuchoice><guimenu>View</guimenu>
610
<guimenuitem>Dictionary</guimenuitem></menuchoice>. You can disable
611
automatic spell checking in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu.</para>
612 613
<para>If you need to write mails in different languages, enable the <guilabel>Dictionary</guilabel> 
drop down box with <menuchoice><guimenu>View</guimenu> <guimenuitem>Dictionary</guimenuitem></menuchoice> 
614
from the menu. Using this drop down box allows you to change the spell checker's language with one mouse click.
615
</para>
616
<para>To check the spelling of your message via a dialog, select
617 618
<menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Spelling...</guimenuitem></menuchoice>. &kmail; uses 
619 620 621 622
&sonnet; to check spelling; &sonnet; is the &kde; frontend to the 
<application>Aspell</application>, <application>Hspell</application>,
<application>Enchant</application>, and <application>HUNSPELL</application> spell
checking programs. Note that you may need to configure the spell checker using
623 624 625 626 627 628 629 630
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Spellchecker...</guimenuitem></menuchoice>.</para>

</sect2>

<sect2 id="setup-text-snippets">
<title>Setting Up the Text Snippets Tool</title>
<para>
631 632
When editing in the composer window you can insert frequently used bits of text as snippets. To configure mail snippets, select <menuchoice> 
<guimenu>View</guimenu> <guimenuitem>Snippets</guimenuitem> </menuchoice> from the menubar. A new panel will appear on the right side of the composer window.
633
</para>
634 635 636 637 638
<para>To add a new snippet to the Snippet Panel, right click on the panel, then click <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. A
<guilabel>Shortcut</guilabel> can also be associated with the snippet. 
Snippets can be grouped together by creating groups and adding snippets to a particular group.
Use the &RMB; context menu to add, edit, or remove snippets of text from the saved collection.
639
</para>
640 641 642
<para>The <guilabel>Snippets</guilabel> tool enables insertion of variable text in predefined places any time you insert a snippet
in a file. To do this, <guilabel>Snippets</guilabel> provides its own variables mechanism. You can insert variables in the snippet
text itself by using separators ( $ ) to enclose the variable names. For example: $variablename$, $invoicenumber$, $weekno$.
643 644
</para>
<para>
645 646
  The variable separator can be changed to another character by changing <varname>snippetDelimiter</varname> in the
  [SnippetPart] section in the Text Snippet configuration file, which can be found at ~./config/kmailsnippetrc.
647 648 649 650 651 652 653 654 655
<programlisting>
snippetDelimiter=$
</programlisting>

</para>

</sect2>
<sect2 id="using-the-translator">
  <title>Using the Built-in Translator</title>
656 657 658 659 660 661 662 663 664 665 666 667
  <para>The &kmail; 2 composer provides a built-in translator that can be accessed by selecting
    <menuchoice><guimenu>Tools</guimenu><guimenuitem>Translator</guimenuitem></menuchoice> from the
    menubar. A new panel will appear at the bottom of the composer window.</para>
    <para> To translate a section of text, first enter the text you would like translated in the
	box labeled <guilabel>Drag text that you want to translate.</guilabel>. Select the language in
    which it is written in the <guilabel>From:</guilabel> drop down box. Select the language you
    would like to translate to in the <guilabel>To:</guilabel> drop down box, then click the
    <guibutton>Translate</guibutton> button. After being translated by Google Translate, a free online service,
    your translated text will appear in the next box. If you need to translate in the other direction
    you can just click the <guibutton>Invert</guibutton> button.
    To clear all text, click the <guibutton>Clear</guibutton> button. </para>
</sect2>
668 669 670 671 672 673 674 675 676 677 678 679 680 681
</sect1>

<sect1 id="folders">
<title>Message Folders</title>
<screenshot>
<screeninfo>Folder Setup Example</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="folder-example.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Folder Setup Example</phrase>
    </textobject>
    <caption>
682
      <para>&kmail;'s default folders.</para>
683 684 685
    </caption>
  </mediaobject>
</screenshot>
686
<para>&nbsp;</para> <!-- whitespace -->
687 688 689 690
<para>Message Folders are used to organize your email messages. When you
  first start &kmail; the <quote>Local Folders</quote> containing <guilabel>inbox</guilabel>,
<guilabel>outbox</guilabel>, <guilabel>sent-mail</guilabel>,
<guilabel>trash</guilabel>, <guilabel>drafts</guilabel> and <guilabel>templates</guilabel> 
691
folders are created. Each of these folders has a special function.</para>
692 693 694 695
<variablelist>
<varlistentry>
<term><guilabel>inbox:</guilabel></term>
<listitem>
696 697
<para>Where &kmail; by default puts your new messages when you tell it to check your
  mail. </para><note><para>&IMAP; accounts will not use this inbox. The &IMAP; inbox is located on the &IMAP; server.</para></note>
698 699 700 701 702
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>outbox:</guilabel></term>
<listitem>
703 704 705 706 707
<para>Where messages are put while they are waiting to be delivered.
You must not just drag and drop messages here to send them; use the <guiicon><inlinemediaobject>
<imageobject><imagedata fileref="mail-send.png" format="PNG"/>
</imageobject></inlinemediaobject> Send</guiicon>
icon in the composer window instead.</para>
708 709 710 711
</listitem></varlistentry>
<varlistentry>
<term><guilabel>sent-mail:</guilabel></term>
<listitem>
712
<para>By default, a copy of every message you send is saved in this folder.</para>
713 714 715 716
</listitem></varlistentry>
<varlistentry>
<term><guilabel>trash:</guilabel></term>
<listitem>
717
<para>By default, all messages that you have designated as trash are moved into this folder.</para>
718 719 720 721
</listitem></varlistentry>
<varlistentry>
<term><guilabel>drafts:</guilabel></term>
<listitem>
722 723
<para>Contains messages you started to write but then saved to this
  folder with <menuchoice><guimenu>Message</guimenu><guimenuitem>Save as Draft</guimenuitem></menuchoice>.</para>
724 725 726 727 728
</listitem></varlistentry>
<varlistentry>
<term><guilabel>templates:</guilabel></term>
<listitem>
<para>This folder holds your templates created via <menuchoice><guimenu>Message</guimenu><guimenuitem>Save as Template</guimenuitem></menuchoice>
729
from the composer window. Please see <link linkend="new-compose-from-templates">New Composer Templates</link> for details.</para>
730 731
</listitem></varlistentry>
</variablelist>
732
<para>&nbsp;</para> <!-- whitespace -->
733 734 735
<sect2 id="folder-details">
<title>Creating and Using Folders</title>

736 737 738 739 740 741
<para>Organize your emails (&eg; mailing lists, bills and receipts, &etc;) by creating new folders. To create a new folder, select
<menuchoice><guimenu>Folder</guimenu><guimenuitem>Add Folder...</guimenuitem></menuchoice>, or <guimenuitem>Add Folder...</guimenuitem> from
the &RMB; context menu. A dialog will pop up. Enter the name of the new folder in the text box. You can fully customize each folder
(&ie; views, replies, &etc;) by selecting the folder you wish to modify in the folders pane and then choosing <guimenuitem>Folder
Properties</guimenuitem> from the &RMB; context menu.
See <link linkend="folders-properties-window">Properties of Folders</link> for details.</para>
742 743

<para>To move messages from one folder into another, select the message(s) you want to move and press the <keycap>M</keycap> key or select
744 745 746
<menuchoice><guimenu>Message</guimenu><guimenuitem>Move Message To... &gt;</guimenuitem></menuchoice>. A list of folders will appear; select the folder
into which you wish to move the message from that list. Messages can also be moved by dragging them from the Message list to a folder in the Folder
list, or by using a context menu invoked with the &RMB;.</para>
747

748 749
<para>If you have folders that are frequently accessed, you can add them to your favorite folders pane (above the list of folders). Add them with the &RMB;
context menu option <guimenuitem>Add to Favorite Folders</guimenuitem>.</para>
750

751 752 753 754 755
<para>You can create a virtual folder with search parameters by going to <menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Find Messages...</guimenuitem></menuchoice>, or by using keyboard shortcut <keycap>S</keycap>. Enter your search parameters into the dialog. Name
your search with the <guilabel>Search folder name:</guilabel> textbox, &eg; <replaceable>emails with the word Blog</replaceable>. Click the <guibutton>Search</guibutton> button. Now select
the <guibutton>Open Search Folder</guibutton> button. A results folder will open, positioned at the bottom of the Folder pane.
(By default, each new search is named "Last Search". You can save particular search parameters by assigning a special name as described above.)</para>
756 757 758 759

<para>Creating filters to automatically move messages to specified folders is a great way to organize messages by mailing list, sender, subject &etc;
Please see <link linkend="filters">Filters</link> for details.</para>

760 761 762 763
<para>If you receive emails from a trusted source (&eg; a Blog you signed up for) that is formatted in &HTML; 
and you would like to enable &HTML; view for those emails only, you can create a new folder, set up a 
<link linkend="filters">filter</link> to place all email from the Blog in the new folder,
select the folder, and then choose <menuchoice><guimenu>Folder</guimenu><guimenuitem>Message Default Format  &gt;</guimenuitem>
764
<guimenuitem>Prefer &HTML; to Plain Text</guimenuitem></menuchoice>.</para>
765
<para>&nbsp;</para> <!-- whitespace -->
766

767
<para>Some common folder actions are</para>
768 769 770 771
<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Folder</guimenu><guimenuitem>Move All Messages to Trash</guimenuitem></menuchoice></term>
<listitem>
772
<para><action>Move</action> all the messages in the selected folder to the trash folder.</para>
773 774 775 776 777 778 779 780 781 782 783 784 785 786
</listitem></varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Folder</guimenu><guimenuitem>Archive Folder</guimenuitem></menuchoice></term>
<listitem>
<para><action>Create an archive</action> of the folder. See <link linkend="folder-archive">Archive Folder</link> for details.</para>
</listitem></varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Folder</guimenu><guimenuitem>Delete Folder</guimenuitem></menuchoice></term>
<listitem>
<para><action>Remove a folder</action> with all its messages and sub-folders.</para>
</listitem></varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Folder</guimenu><guimenuitem>Remove Duplicate Messages</guimenuitem></menuchoice></term>
<listitem>
787
<para><action>Search</action> the currently selected folder for duplicates and <action>delete</action> them.</para>
788 789
</listitem></varlistentry>
</variablelist>
790
<para>&nbsp;</para> <!-- whitespace -->
791 792 793 794 795 796 797 798 799 800 801 802 803 804
</sect2>

<sect2 id="folders-properties-window">
<title>Folder Properties</title>
<screenshot>
<screeninfo>Folder Properties Example</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="folder-properties.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Folder Properties Example</phrase>
    </textobject>
    <caption>
805
      <para>The Folder Properties Dialog</para>
806 807 808
    </caption>
  </mediaobject>
</screenshot>
809 810 811
<para>&nbsp;</para> <!-- whitespace -->
<para>The <guilabel>Properties of Folder</guilabel> dialog lets you specify its properties. Note that some properties are only
available for the folders you create and not for default folders like <guilabel>inbox</guilabel> &etc; The six default folders cannot be renamed.</para>
812 813

<sect3 id="folders-properties-general">
814 815
<title>General tab</title>
<para>If you want to rename a folder, change the entry in the <guilabel>Name:</guilabel> field.</para>
816

817 818 819
<para><guilabel>Act on new/unread mail in this folder</guilabel> is enabled by default on new folders. It enables notifications about new mail that arrives in the folder. Uncheck this option on folders like SPAM and trash for which you do not desire notifications.</para>
<para>Check <guilabel>Keep replies in this folder</guilabel> if you want
replies to these messages to be stored in this folder rather than in the default configured sent-mail folder.</para>
820 821 822 823

<para>Check <guilabel>Hide this folder in the folder selection dialog</guilabel> if you do not want this folder to be shown in folder selection dialogs,
such as the <guimenuitem>Jump to Folder</guimenuitem> and <guimenuitem>Move Message to</guimenuitem> dialogs.</para>

824 825
<para>New folders use the default identity. If you wish to associate a folder with a different identity, uncheck
<guilabel>Use default identity</guilabel> and select a different one
826
from the <guilabel>Sender identity</guilabel> drop down menu. See <link linkend="configure-identity">Identities configuration</link> for
827 828
information on Identities. Replies to messages that were sent directly to you will still default to the message's <quote>To</quote> address if a
matching identity is found.</para>
829

830
<!-- <para>If you have groupware, you can change the contents &eg; calendar, notes, &etc; of the folder in the
831 832 833
<guilabel>Folder contents:</guilabel> drop down box.</para>

<para>If you share the folder with other users, you can <guilabel>Share unread state with all users</guilabel> which will show the same unread state for all users.</para>
834
<informalexample><para>For example, a ticket system that all emails must be read and multiple users are responsible for reading unread tickets.</para></informalexample> -->  <!-- I cannot find any "groupware" functionality in kmail. @dcb2020291 -->
835 836 837
</sect3>

<sect3 id="folders-properties-view">
838 839 840 841
<title>View tab</title>
<para>The <guilabel>Use custom icons</guilabel> option lets you choose icons that are different from the defaults in the folder list.</para>
<para>With the <guilabel>Show column</guilabel> drop down list you can set the visible columns in the header pane to Default, Sender, or Receiver. This may be useful
if you use a custom folder to save some of your own sent messages.</para>
842
<para>In the <guilabel>Message List</guilabel> section you can select and configure an <guilabel>Aggregation</guilabel> and <guilabel>Theme</guilabel>
843 844 845
for this folder that differs from the default configured in &kmail;s settings. For more details see the <link linkend="configure-appearance-message-list">
Message List</link> tab on the <guilabel>Appearance</guilabel> page.</para>
<para>The <guilabel>Message Default Format</guilabel> section lets you choose between plain and &HTML; displays for messages in this folder.</para>
846
</sect3>
847

848
<sect3 id="folders-properties-retrieval">
849 850 851 852 853
<title>Retrieval tab</title>
<para>If you have an account that does not receive much mail and you don't want &kmail; to query the server too often, you can uncheck <guilabel>Use options from parent folder or account</guilabel> to set
a longer interval in the <guilabel>Automatically synchronize after:</guilabel> spin box.</para>
<para>In <guilabel>Retrieval Options</guilabel> you can change the <guilabel>Always retrieve full messages</guilabel> option to <guilabel>Retrieve message
bodies on demand</guilabel> if you have a slow connection. You can also set how long the message will be retained locally via the spin box.
854 855
</para>
</sect3>
856

857
<sect3 id="folders-properties-templates">
858
<title>Templates tab</title>
859 860
<para>On this tab you can define folder-specific templates for your custom folders.  
For more details see the <link linkend="configure-composer-standard-templates">
861
Standard Templates</link> tab on the <guilabel>Composer</guilabel> page.
862 863 864 865
</para>
</sect3>

<sect3 id="folders-properties-expiry">
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
<title>Expiry tab</title>
<para>You can set up automatic cleanup or deletion of emails. Check the box if you would like to automatically expire
read or unread messages respectively. Set the number of days in the spin box. If you do not want to delete the messages permanently, you can
assign a folder to keep them in via the <guilabel>Move expired messages to:</guilabel> text box / folder selection dialog. Once you have reviewed
the messages and want to delete them permanently,
you can go to the folder expiry options of the folder you chose to move them to and set the option <guilabel>Delete expired messages
permanently</guilabel>, then click the <guibutton>Save Settings and Expire Now</guibutton> button.
</para>
<warning><para>Messages that are deleted cannot be restored, so be careful with this setting.</para></warning>
<para>&nbsp;</para> <!-- whitespace -->
</sect3>

<sect3 id="folders-properties-mailinglist">
<title>Mailing List tab</title>

<para>If you are going to use the folder for a mailing list open the
<guilabel>Mailing List Folder Properties</guilabel> dialog with
<menuchoice><guimenu>Folder</guimenu> <guimenuitem>Mailing List Management</guimenuitem>
</menuchoice> from the menu. Then you should
check <guilabel>Folder holds a mailing list</guilabel> to associate this folder
with the mailing list. Next you should click on <guilabel>Detect Automatically</guilabel>. &kmail; will then try
to guess some information about the mailing list from the currently selected
message. If &kmail; could not determine some addresses then you can add
the missing information manually. To do this first select the
<guilabel>Address type</guilabel> for which you want to add an address.
You can choose among five options.</para>
<variablelist>
<varlistentry id="folders-properties-mailinglist-post">
<term><guilabel>Post to List</guilabel></term>
<listitem>
<para>This address is used for sending messages to the mailing list. This is usually an email address.</para>
</listitem></varlistentry>
<varlistentry id="folders-properties-mailinglist-subscribe">
<term><guilabel>Subscribe to List</guilabel></term>
<listitem>
<para>This address is used for subscribing to the mailing list. This can be an email address or the address of a web page.</para>
</listitem></varlistentry>
<varlistentry id="folders-properties-mailinglist-unsubscribe">
<term><guilabel>Unsubscribe From List</guilabel></term>
<listitem><para>This address is used for unsubscribing from the mailing list. This can be an email address or the address of a web page.</para>
</listitem></varlistentry>
<varlistentry id="folders-properties-mailinglist-archive">
<term><guilabel>List Archives</guilabel></term>
<listitem><para>This is the address of the archive of the mailing list. This is usually the address of a web page.</para>
</listitem></varlistentry>
<varlistentry id="folders-properties-mailinglist-help">
<term><guilabel>List Help</guilabel></term>
<listitem>
<para>This address is used for requesting help for this mailing list. This is usually an email address.</para>
</listitem></varlistentry>
</variablelist>

<para>After selecting the appropriate <guilabel>Address type</guilabel>,
enter the email address or the address of the web page and then click on
<guilabel>Add</guilabel>. With <guilabel>Remove</guilabel> you can remove
addresses.</para>

<para>When all the addresses have been added, you can execute an action, &eg;
go to the list archives, by selecting the appropriate
<guilabel>Address type</guilabel> and then clicking on
<guilabel>Invoke Handler</guilabel>. If there is an email address and an
address of a web page for the desired action, you will have to select
the <guilabel>Preferred handler</guilabel> prior to clicking on
<guilabel>Invoke Handler</guilabel>. Select <guilabel>KMail</guilabel> if you
want to send a message to the email address and select
<guilabel>Browser</guilabel> if you want to go to the web page.</para>

<para>You can also send a new message to the
mailing list via <menuchoice><guimenu>Message</guimenu><guimenuitem>New
        Message to Mailing-List...</guimenuitem></menuchoice> (instead of <guilabel>Invoke Handler</guilabel>).</para>
</sect3>

<sect3 id="folders-properties-shortcut">
<title>Shortcut tab</title>
<para>You can define a keyboard shortcut to access the folder.</para>
</sect3>

<sect3 id="folders-properties-maintainance">
<title>Maintenance tab</title>
<para>This tab shows an overview about the folder type and its size, 
the number of read and unread messages in the folder and allows you to enable
text indexing.</para>
</sect3>

<sect3 id="folders-properties-quota">
<title>Quota tab (&IMAP; only)</title>
<para>
This tab will show you how much space has been allocated to your &IMAP; account by the server,
and also how much of the allocated space you are currently using.
955 956 957 958
</para>
</sect3>

<sect3 id="folders-properties-acl">
959 960 961
<title>Access Control tab (&IMAP; only)</title>
<para>Here you can manage the access control lists (&acl;s) of &IMAP; folders.</para>
<note><para>The &IMAP; server must have user level &acl; configured and enabled for this tab to be visible.</para></note>
962 963 964
<para>The currently active &acl; is shown in the list. It consists of pairs of <guilabel>User Id</guilabel>s and the
 <guilabel>Permissions</guilabel> granted to users identified by that <guilabel>User Id</guilabel>.
 <footnote>
965
 <para>Note that a single <guilabel>User Id</guilabel> might refer to more than one user. Depending on the &IMAP;
966
 server and its configuration, there may be User Ids that correspond to groups of users, anonymous users, or any user.
967
 Consult the manual of your specific &IMAP; server implementation for more information.</para>
968
 </footnote> &acl;s are settable per-folder.</para>
969
 <note><para>As with everything else when using <emphasis>disconnected &IMAP;</emphasis>, you need to sync with the server for
970
 the changes to be transferred to the server.</para></note>
971
<para>&IMAP; &acl;s define a lot of fine-grained permissions that you can grant or deny other users. For the sake of clarity,
972
 &kmail; will present them as the following five categories that you can choose from (see <xref linkend="table-acl-summary"/>
973
 for the details if you already know &IMAP; &acl;s).</para>
974 975 976 977 978 979
<variablelist>
<varlistentry id="folders-properties-acl-none">
<term><guilabel>None</guilabel></term>
<listitem>
<para>Grants the users identified by <guilabel>User Id</guilabel> no rights at all. This is also the
 default for users not explicitly (or implicitly, as a group) listed in the &acl;. These users will not see this folder in the list of
980
 &IMAP; folders presented to them by their mail clients.</para>
981 982 983 984 985 986 987 988 989 990 991
</listitem></varlistentry>
<varlistentry id="folders-properties-acl-read">
<term><guilabel>Read</guilabel></term>
<listitem>
<para>Grants the users identified by <guilabel>User Id</guilabel> reading rights for this folder. This also
 includes the ability for their mail clients to mark mails as read and store this information on the server.
<footnote>
<para>Every user has their own list of read mail, so none of your unread mails will suddenly be marked as
 read just because someone else has already read them.</para>
</footnote>
</para>
992
<para>These users will see this folder in the list of &IMAP; folders presented to them by their mail clients.</para>
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
<para>Use this to create a shared folder that others can read, but not modify.</para>
<informalexample>
<para>If you were the editor of a company's news letter, you could create a folder for the purpose of
 distributing the news letter, grant everyone reading rights, and save the letter to this folder instead
 of sending it out by email to a catch-all address.</para>
</informalexample>
</listitem></varlistentry>
<varlistentry id="folders-properties-acl-append">
<term><guilabel>Append</guilabel></term>
<listitem>
<para>(also known as <guilabel>Post</guilabel>)</para>
<para>Grants the users identified by <guilabel>User Id</guilabel> reading (see above) and posting rights for this folder.</para>
<para>Use this to create a shared folder that others can read and post messages to, but cannot otherwise modify.</para>
<informalexample>
<para>If you wanted to create a company-wide discussion forum, instead of using a web-based form or a separate company-private usenet server,
 you could create a bunch of folders (one per topic), and grant everyone reading and posting rights. Instead of posting to an &nntp;
 server or writing their messages into a web form, people would just write emails and store them in the folder suiting the topic of the message.</para>
</informalexample>
</listitem></varlistentry>
<varlistentry id="folders-properties-acl-write">
<term><guilabel>Write</guilabel></term>
<listitem>
<para>Grants the users identified by <guilabel>User Id</guilabel> reading, posting (see above), and writing rights for this folder.</para>
<para>The right to write to a folder includes deleting of messages, creating subfolders, and storing other attributes than
 read/unread on the server (&eg; answered).</para>
<para>Use this to create a shared folder that everyone has (almost, see <xref linkend="folders-properties-acl-all"/>) the same rights for.</para>
<informalexample>
<para>In the <xref linkend="folders-properties-acl-append"/> example, you could assign write rights to a group of people
1021
 acting as moderators, who would then be able to remove off-topic posts, and create sub-topic folders for high-traffic folders.</para>
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
</informalexample>
</listitem></varlistentry>
<varlistentry id="folders-properties-acl-all">
<term><guilabel>All</guilabel></term>
<listitem>
<para>Grants the users identified by <guilabel>User Id</guilabel> reading, posting, writing (see above),
 as well as administration rights, &ie; the right to modify the &acl; of this folder.</para>
<para>This is the default set of rights for the owner of a folder.</para>
</listitem></varlistentry>
</variablelist>
1032
<para><xref linkend="table-acl-summary"/> summarizes the &IMAP; &acl; rights associated with each permission level.</para>
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
<table id="table-acl-summary">
<title>&acl; Rights Summary</title>
          <tgroup cols="6">
            <thead>
              <row>
                <entry>&acl; right</entry>
                <entry><xref linkend="folders-properties-acl-none"/></entry>
                <entry><xref linkend="folders-properties-acl-read"/></entry>
                <entry><xref linkend="folders-properties-acl-append"/></entry>
                <entry><xref linkend="folders-properties-acl-write"/></entry>
                <entry><xref linkend="folders-properties-acl-all"/></entry>
              </row>
            </thead>
            <!--tfoot/-->
            <tbody>
              <row>
                <entry>Lookup</entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Read</entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Store Seen</entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Insert</entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Post</entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Write Flags</entry>
                <entry></entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Create</entry>
                <entry></entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Delete</entry>
                <entry></entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
                <entry>x</entry>
              </row>
              <row>
                <entry>Administer</entry>
                <entry></entry>
                <entry></entry>
                <entry></entry>
                <entry></entry>
                <entry>x</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
</sect3>

</sect2>
</sect1>

<sect1 id="filters">
<title>Message Filters</title>
<anchor id="filters-id"/>
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
<screenshot>
<screeninfo>The Filter Dialog</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="filter-dialog.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>The Filter Dialog</phrase>
    </textobject>
    <caption>
      <para>The Filter Creation Dialog</para>
    </caption>
  </mediaobject>
</screenshot>
<para>&nbsp;</para> <!-- whitespace -->
1146 1147 1148 1149 1150 1151

<para>After using &kmail; for a while, you may find that you have trouble
sorting out the new messages in your inbox when they arrive. Filters allow you
to automatically perform certain actions on incoming messages and to manually
perform actions on selected messages in a folder.</para>

1152 1153 1154 1155
<para>Filters consist of filter criteria, whose rules are used
to determine whether this filter should be applied to a given
message, and a list of filter actions, which describe what is to be
done with, or to, the message if the search pattern matches.</para>
1156 1157 1158

<note><para>Filters are considered one after the other,
starting with the first filter in the list. The first one whose
1159 1160
pattern matches the given message is applied; you can request that
the remaining filters also be processed, but the default is to stop
1161 1162 1163 1164 1165 1166 1167 1168
processing at the first matching filter. </para></note>

<para>Usually, filters are used on incoming messages, but they can
also be applied to sent messages or to an arbitrary message or group
of messages. To selectively filter messages, select the messages you
want to filter in the message list and either type <keycombo
action="simul">&Ctrl;<keycap>J</keycap> </keycombo> or select
<menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply
1169
Filter</guimenuitem></menuchoice>. This will apply the filters (the ones that
1170
have been marked for manual filtering in the <link
1171
linkend="filter-dialog">advanced filter dialog</link>) to those messages.</para>
1172 1173 1174 1175 1176 1177

<sect2 id="filter-quick">
<title>Fast Filter Creation</title>

<para>There are two methods for creating a filter; the quick method is
to use <menuchoice><guimenu>Message</guimenu><guimenuitem>Create
1178
Filter</guimenuitem></menuchoice> and select a criterion from the submenu. This will open the filter dialog
1179 1180 1181
and present you with a new filter which has the first rule of the
search pattern and the first action (as <guilabel>Move into Folder</guilabel>) 
preset. In most cases, all you have to do is select the folder where the message
1182
should be moved, but you can, of course, edit the filter as you
1183 1184
like.</para>

1185 1186 1187
<para>When creating a filter on mailing list messages, this method 
will try to find a criterion that
uniquely identifies messages from the list. If it succeeds, the guessed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
name of the list is presented in the
<menuchoice><guimenu>Message</guimenu><guisubmenu>Create
Filter</guisubmenu><guimenuitem>Filter on
Mailing-List...</guimenuitem></menuchoice> menu entry.</para>

<para>The second method is to manually construct a filter from scratch
by calling the filter dialog through
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure 
Filters...</guimenuitem></menuchoice>. The filter dialog is described in
detail in the following subsection.</para>
1198
<para>&nbsp;</para> <!-- whitespace -->
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
</sect2>

<sect2 id="filter-dialog">
<title>The Filter Dialog</title>
<anchor id="filter-dialog-id"/>

<para>This dialog allows you to manage and edit your list of
filters.</para>

<para>You can reach it either via
<menuchoice><guimenu>Message</guimenu><guisubmenu>Create
Filter</guisubmenu></menuchoice> or
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure 
Filters...</guimenuitem></menuchoice>.</para>

<para>The dialog is divided into three main sections on the <guilabel>General</guilabel> 
1215
and <guilabel>Advanced</guilabel> tabs.</para>