diff options
Diffstat (limited to 'doc/kmail')
| -rw-r--r-- | doc/kmail/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/kmail/configure.docbook | 2048 | ||||
| -rw-r--r-- | doc/kmail/credits-and-licenses.docbook | 153 | ||||
| -rw-r--r-- | doc/kmail/faq.docbook | 590 | ||||
| -rw-r--r-- | doc/kmail/getting-started.docbook | 329 | ||||
| -rw-r--r-- | doc/kmail/importing.docbook | 270 | ||||
| -rw-r--r-- | doc/kmail/index.docbook | 161 | ||||
| -rw-r--r-- | doc/kmail/intro.docbook | 56 | ||||
| -rw-r--r-- | doc/kmail/menus.docbook | 2222 | ||||
| -rw-r--r-- | doc/kmail/using-kmail.docbook | 2303 |
10 files changed, 8136 insertions, 0 deletions
diff --git a/doc/kmail/Makefile.am b/doc/kmail/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kmail/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kmail/configure.docbook b/doc/kmail/configure.docbook new file mode 100644 index 000000000..a66665ad3 --- /dev/null +++ b/doc/kmail/configure.docbook @@ -0,0 +1,2048 @@ +<chapter id="configure"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<author> +<firstname>Marc</firstname> +<surname>Mutz</surname> +<affiliation> +<orgname>Klarälvdalens Datakonsult AB</orgname> +<address> +<email>mutz@kde.org</email> +</address> +</affiliation> +</author> +<author> +<firstname>Michel</firstname> +<surname>Boyer de la Giroday</surname> +<affiliation><address> +<email>michel@kdab.net</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-13</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Configure &kmail;</title> + +<sect1 id="configure-generalinfo"> +<title>General Information</title> + +<para>&kmail;'s configuration window enables you to configure &kmail; +in many ways. You can reach it via +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice>.</para> + +<para>It is divided into six +pages, each of them represented by one of the +icons in the list on the left hand side of the dialog. Below the pages +will be described in detail.</para> + +<para>The dialog has several buttons:</para> + +<variablelist> +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem><para>This will open this manual at the appropriate page.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Defaults</guibutton></term> +<listitem><para>This will reset the configuration options on the current +page back to the default values.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Load Profile...</guibutton></term> +<listitem><para>This will open a dialog which offers several configuration +profiles. You can use these as starting points for your own configuration.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Reset</guibutton></term> +<listitem><para>This resets all changes you have made since you last saved +the settings.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>OK</guibutton></term> +<listitem><para>This saves the settings and closes the configuration dialog.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Apply</guibutton></term> +<listitem><para>This saves the settings without closing the configuration +dialog.</para></listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem><para>This closes the configuration dialog without saving the +changes you have made.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="configure-identity"> +<title>Identities Page</title> + +<para>You can find a quick introduction to the +<guilabel>Identities</guilabel> page in the <link +linkend="getting-started">Getting Started</link> section.</para> + +<para>This page allows you to create one or more +<emphasis>Identities</emphasis>, &ie; combinations of name, email +address and other settings. For example, you can create one identity +for business communication and one for +personal communication. If you have more than one email +address, you can create one identity per address. You will then be +able to select an identity on a per-message basis.</para> + +<para>The page consists of a list of identities and buttons to manage +them. The identities list will always show at +least one identity, which is then the <guilabel>Default</guilabel> +identity.</para> + +<para>To add a new identity to the identity list, click on the +<guibutton>New...</guibutton> button. +The <link linkend="configure-identity-newidentitydialog">New identity</link> dialog +will then appear.</para> + +<sect2 id="configure-identity-newidentitydialog"> +<title>The <guilabel>New Identity</guilabel> Dialog</title> + +<para>You have to enter the name of the new identity into the +<guilabel>New Identity</guilabel> edit field. This will be the name +shown in the identity list.</para> + +<para>You can choose how the new identity should be initialized by +checking one of the three radio buttons in the middle of the +dialog:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>With empty fields</guilabel></term> +<listitem> +<para>All fields of the new identity are cleared or preset with +standard values.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use Control Center settings</guilabel></term> +<listitem> +<para>Uses the settings of the <application>Control +Center</application>'s default email profile (you can edit that one +under <menuchoice><guimenu>Internet & Network</guimenu> +<guimenuitem>Email</guimenuitem></menuchoice> in the +<application>Control Center</application>).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Duplicate existing identity</guilabel></term> +<listitem> +<para>Copies all fields from an existing identity. You can +choose which identity to copy from by selecting the corresponding +entry in the <guilabel>Existing identities</guilabel> popup.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="configure-identity-general"> +<title>General</title> + +<para>The <guilabel>General</guilabel> tab allows you to specify some +basic settings for the currently selected identity.</para> +<variablelist> +<varlistentry> +<term><guilabel>Your name</guilabel></term> +<listitem> +<para>Enter your full name here (sometimes also called <emphasis>display name</emphasis>). +Although this field is not strictly mandatory, it is recommended to enter +the correct value here.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Organization</guilabel></term> +<listitem> +<para>Enter your organization here. This field is optional.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Email address</guilabel></term> +<listitem> +<para>Enter your email address here, &ie; something like +<userinput>joe@example.com</userinput>.</para> +</listitem> +</varlistentry> +</variablelist> +<example> +<title>Example</title> +<para>So if your address is <replaceable>Joe User +<joe@example.com></replaceable>, you should enter <userinput>Joe +User</userinput> into the <guilabel>Your name</guilabel> field and +<userinput>joe@example.com</userinput> into the <guilabel>Email +address</guilabel> field.</para></example> +</sect2> + + <sect2 id="configure-identity-cryptography"> + <title> + Cryptography + </title> + + <para> + The <guilabel>Cryptography</guilabel> tab allows you to + specify &openpgp; and &smime; keys associated with this + identity, as well as choosing the preferred (cryptographic) + message format to use. + </para> + + <variablelist> + + <varlistentry id="configure-identity-cryptography-openpgp-sign"> + <term> + <guilabel>OpenPGP signing key</guilabel> + </term> + <listitem> + <para> + Here you can select the key to be used when + &openpgp;-signing messages written with this identity in + effect. + </para> + <para> + For brevity, only the short key id of selected keys is + shown. Hovering with the mouse over the key list will + show more information in a tooltip. + </para> + <para> + To clear the label press the + <guibutton>Clear</guibutton> button. + </para> + <para> + To change the selected key, press the + <guibutton>Change...</guibutton> button. A dialog + listing all secret &openpgp; keys will be shown allowing + you to select the one to use. + </para> + </listitem> + </varlistentry> + + + <varlistentry id="configure-identity-cryptography-openpgp-encrypt"> + <term> + <guilabel>OpenPGP encryption key</guilabel> + </term> + <listitem> + <para> + Here you can select the key to &openpgp;-encrypt + messages to when this identity and <xref + linkend="configure-security-composing-encrypt-to-self"/> + are in effect. This key is also used for the <xref + linkend="composer-attach-attach-my-public-key"/> + function of the <link + linkend="the-composer-window">Composer</link>. + </para> + <para> + To change the selected key, press the + <guibutton>Change...</guibutton> button. A dialog + listing all &openpgp; keys found in your keyring will be + shown allowing you to select the one to use. + </para> + <para> + You can clear the list of keys and get more information + about them in the same way as described for <xref + linkend="configure-identity-cryptography-openpgp-sign"/>. + </para> + </listitem> + </varlistentry> + + + <varlistentry id="configure-identity-cryptography-smime-sign"> + <term> + <guilabel>&smime; signing certificate</guilabel> + </term> + <listitem> + <para> + Here you can select the certificate to be used when + &smime;-signing messages written with this identity in + effect. + </para> + <para> + To change the selected certificate, press the + <guibutton>Change...</guibutton> button. A dialog + listing all secret &smime; signing certificates will be + shown allowing you to select the one to use. + </para> + <para> + You can clear the list of certificates and get more + information about them in the same way as described for + <xref linkend="configure-identity-cryptography-openpgp-sign"/>. + </para> + </listitem> + </varlistentry> + + + <varlistentry id="configure-identity-cryptography-smime-encrypt"> + <term> + <guilabel>&smime; encryption certificate</guilabel> + </term> + <listitem> + <para> + Here you can select the certificate to &smime;-encrypt + messages to when this identity and <xref + linkend="configure-security-composing-encrypt-to-self"/> + are in effect. + </para> + <para> + To change the selected certificate, press the + <guibutton>Change...</guibutton> button. A dialog + listing all &smime; encryption certificates found in + your local keybox will be shown allowing you to select + the one to use. + </para> + <para> + You can clear the list of certificates and get more + information about them in the same way as described for + <xref linkend="configure-identity-cryptography-openpgp-sign"/>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-identity-cryptography-preferred-format"> + <term> + <guilabel>Preferred crypto message format</guilabel> + </term> + <listitem> + <para> + Here you can choose which cryptographic message format + to use by default with this identity. + </para> + <para> + You can either select any of the four formats supported + by &kmail; or leave the option at the recommended + default setting of <guilabel>Any</guilabel>, which will + choose a suitable format based on the recipients of the + message, or might even go so far as to create two copies + of the message, one &smime; signed and/or encrypted, the + other &openpgp; signed and/or encrypted. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> + +<sect2 id="configure-identity-advanced"> +<title>Advanced</title> + +<para>The <guilabel>Advanced</guilabel> tab allows you to specify some +rarely used or otherwise specialized settings for the currently +selected identity.</para> +<variablelist> + +<varlistentry> +<term><guilabel>Reply-To address</guilabel></term> +<listitem> +<para>Enter the address to which replies to your messages should be +sent. Only fill out this field if it is different from your normal +address (specified using the <guilabel>Name</guilabel> and +<guilabel>Email Address</guilabel> on the <link +linkend="configure-identity-general"><guilabel>General</guilabel> +tab</link>), since replies default to the sender's address +anyway.</para> +<note><para>This field is only useful if you want replies to your mail +to go somewhere else than your regular email address, ⪚ if you are +using this identity to send messages from an email address that cannot +receive messages. Note that +some mailing lists overwrite this header field with their post address to +make sure that replies go to the list instead of individuals. So the +usefulness of this field is very limited and it should only be used in +rare cases.</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>BCC address</guilabel></term> +<listitem> +<para>Optionally enter an address to which blind copies of your messages +should be sent to. Note that a BCC is only send to this address, when +<menuchoice><guimenu>View</guimenu><guimenuitem>BCC</guimenuitem></menuchoice> +is activated while composing a message. If you want to send a BCC regardless +of this setting, you should look at the <guilabel>Headers</guilabel> tab of the +<guilabel>Composer</guilabel> page.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Sent-mail folder</guilabel></term> +<listitem> +<para>Select the folder into which messages should be filed after sending +when using this identity. <acronym>IMAP</acronym> users should consider changing this to an +<acronym>IMAP</acronym> folder, so their sent-mail is stored on a server instead of being +stored in a local folder. This way they can access these messages at a +different location.</para> + +<tip><para>You can exercise more fine-grained control over where to +file sent messages by creating a corresponding <link +linkend="filters">message filter</link> that is applied to outgoing +messages.</para></tip> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Drafts folder</guilabel></term> +<listitem> +<para>Select the folder into which drafts should be filed when using +this identity. <acronym>IMAP</acronym> users should consider changing this to an +<acronym>IMAP</acronym> folder, so their drafts are stored on a server instead of being +stored in a local folder. This way they can easily continue to work +on their drafts at a different location.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Special transport</guilabel></term> +<listitem> +<para>Select or enter an alternative SMTP server to be used when sending +messages using this identity.</para> + +<note><para>You need to configure outgoing mail servers first, before +you can choose them from the list. You can do this on the <link +linkend="configure-accounts-sending"><guilabel>Sending</guilabel> +tab</link> of the <link linkend="configure-accounts"> +<guilabel>Accounts</guilabel> page</link>.</para></note> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="configure-identity-signature"> +<title>Signature</title> + +<para>This tab allows you to specify a signature (sometimes called +<quote>footer</quote> or <quote>disclaimer</quote>) +to be appended to each message sent using this identity.</para> + +<note><para>This type of signature has nothing to do with the +(digital) signatures for which you can select the keys to use on +the <link linkend="configure-identity-cryptography">Cryptography</link> +tab. It is just bad wording to call this a signature, but since +the term is already used everywhere else, we keep this notation. Just +keep in mind that these signatures and digital signatures are two +completely different things.</para></note> + +<para>Check the <guilabel>Enable signature</guilabel> option if you +want to be able to append the signature when using this identity. To +<emphasis>automatically</emphasis> append it to every new message +you also have to select <guilabel>Automatically append +signature</guilabel> in the <guilabel>Composer</guilabel> configuration page.</para> + +<para>&kmail; can obtain the signature text from various sources. The +traditional way on Unix is to read the text from a file called +<filename>.signature</filename> in your home folder. This file can +be shared between several programs, so you get the same +signature in each mail program you use.</para> + +<para>To read the text from a text file you select +<guilabel>Obtain signature text from file</guilabel>. Enter the +filename in the <guilabel>Specify file</guilabel> edit field or hit +the button to the right of it to browse your filesystem. If you want +to edit the file, hit the <guilabel>Edit File</guilabel> +button.</para> + +<para>&kmail; can also read the signature text from the output of a +command. Thus, you can use programs such as +<command>fortune</command> to create a new signature text for +every message. Everything the program prints onto +<acronym>stdout</acronym> is caught and used as the signature +text.</para> + +<para>To read the text from the output of a command you select +<guilabel>Obtain signature text from Output of +Command</guilabel>. Enter the command (preferably with full path) in +the <guilabel>Specify command</guilabel> edit field.</para> + +<para>As a third option, you can enter the signature text directly in +&kmail;'s configuration dialog. To do this, select <guilabel>Obtain +signature text from input field below</guilabel> and enter the text +into the appearing text box.</para> + +<note><para>On the Internet, signatures are by convention separated +from the body of the message by a line containing only the three +character <quote>-- </quote> (dash, dash, space). &kmail; will +automatically prepend the signature text with this line if it is not +already present in the signature text.</para> +<para>If you do not wish the separator to be prepended +automatically by &kmail;, simply add it to the signature +text yourself.</para> +</note> + +</sect2> + +</sect1> + +<sect1 id="configure-accounts"> +<title>Accounts Page</title> + +<para>You can find a quick introduction to the +<guilabel>Accounts</guilabel> page in the <link +linkend="setting-up-your-account">Setting up your Account</link> +section.</para> + +<para>This page allows you to create one or more (incoming and +outgoing) <emphasis>accounts</emphasis>, &ie; combinations of mail +servers, login information and other settings. Typically, you will +create one outgoing (used for sending messages) and one incoming (used to +retrieve messages) account. You can create as many accounts as you want, though, +and assign each one to different <link +linkend="configure-identity">identities</link> or decide on a per-message +basis.</para> + +<sect2 id="configure-accounts-sending"> +<title>Sending</title> + +<para>The <guilabel>Sending</guilabel> tab allows you to define new +outgoing mail servers and set some common options.</para> + +<para>For basic information, see <link +linkend="sending-mail">Setting up your Account: Sending</link>.</para> + +<para>When you click <guibutton>Add...</guibutton> or +<guibutton>Modify...</guibutton> the <guilabel>Add +transport</guilabel> or <guilabel>Modify transport</guilabel> dialogs +will open respectively. For sending via <application>sendmail</application> +or similar programs +you can specify a name and the location of the +<command>sendmail</command> program. For <acronym>SMTP</acronym> you +can specify <guilabel>Name</guilabel>, <guilabel>Host</guilabel>, and +<guilabel>Port</guilabel> of the server. <guilabel>Server requires +authentication</guilabel> will enable the <guilabel>Login</guilabel> +and <guilabel>Password</guilabel> fields and the +<guilabel>Authentication method</guilabel> buttons on the +<guilabel>Security</guilabel> tab. If you are not sure about the +security settings you can make &kmail; test for the best settings by +using <guibutton>Check What the Server Supports</guibutton>.</para> + +<para><guilabel>Confirm before send</guilabel> will pop up a +confirmation box every time you send a message.</para> + +<para><guilabel>Send messages in outbox folder</guilabel> lets you specify +when queued messages, &ie; messages in the outbox folder pending to be sent, +should be sent. You can choose between:</para> +<variablelist> +<varlistentry> +<term><guilabel>Never Automatically</guilabel></term> +<listitem><para>Queued messages will only be sent if you select +<menuchoice><guimenu>File</guimenu><guimenuitem>Send queued messages</guimenuitem></menuchoice>.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>On Manual Mail Checks</guilabel></term> +<listitem><para>Queued messages will be sent after you have manually checked +for new mail, ⪚ with <menuchoice><guimenu>File</guimenu><guimenuitem>Check Mail</guimenuitem></menuchoice>. Of course, you can also +manually send the queued messages with +<menuchoice><guimenu>File</guimenu><guimenuitem>Send queued messages</guimenuitem></menuchoice>.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>On All Mail Checks</guilabel></term> +<listitem><para>Queued messages will be sent after all checks for new mail, +&ie; after automatic mail checks as well as after manual mail checks. +Of course, you can also manually send the queued messages with +<menuchoice><guimenu>File</guimenu><guimenuitem>Send queued messages</guimenuitem></menuchoice>.</para></listitem> +</varlistentry> +</variablelist> + +<para><guilabel>Default send method</guilabel> lets you define what +happens when a message is sent. If <guilabel>Send now</guilabel> is +selected, the message is sent to the mail server immediately, while if +<guilabel>Send later</guilabel> is selected, the message is queued in +the outbox to be sent later with the +<menuchoice><guimenu>File</guimenu><guimenuitem>Send +Queued Messages</guimenuitem></menuchoice> command or automatically when you +check your mail, depending on the setting of +<guilabel>Send messages in outbox folder</guilabel> above.</para> + +<para><guilabel>Message property</guilabel> lets you select how your +message will be encoded when it is sent. <guilabel>Allow +8-bit</guilabel> means that &kmail; will send your message in 8-bit +<acronym>ASCII</acronym>, which means that all special characters such +as accented letters will be sent as-is. If <guilabel>MIME Compliant +(Quoted Printable)</guilabel> is selected, special characters will be +encoded using standard &MIME; encodings, which may be more portable to +mailing systems other than 8-bit <acronym>ASCII</acronym>. +We recommend to use <guilabel>MIME Compliant</guilabel>.</para> + +<note><para>Even with <guilabel>Allow 8-bit</guilabel> +selected &kmail; will use <guilabel>MIME +Compliant</guilabel> encoding in some situations, for +example for sending cryptographically signed messages.</para></note> + +<para><guilabel>Default domain</guilabel> lets you specify which domain name +should be used to complete email addresses that only consist of the recipient's user +name. For example when you set the default domain to <replaceable>kde.org</replaceable> +then messages you send to <replaceable>johndoe</replaceable> will be sent to +<replaceable>johndoe@kde.org</replaceable>.</para> + +</sect2> + +<sect2 id="configure-accounts-receiving"> +<title>Receiving</title> + +<para>For basic information, see <link +linkend="receiving-mail">Setting up your Account: Receiving</link>.</para> + +<para><guilabel>Check mail on startup</guilabel> lets you specify whether +KMail should check for new mail immediately after it has been started.</para> + +<para>With <guilabel>New Mail Notification</guilabel> you can set +how &kmail; will notify you if new messages have arrived: +<guilabel>Beep</guilabel> will play a short beep sound; +if <guilabel>Detailed new mail notification</guilabel> is enabled then +&kmail; will show the number of new messages for each folder provided +you have chosen to be notified with a dialog. More advanced +notification options, like showing a dialog or running a certain command, +are available via the <guibutton>Other Actions</guibutton> button.</para> + +</sect2> + +</sect1> + +<sect1 id="configure-appearance"> +<title>Appearance Page</title> + +<sect2 id="configure-appearance-fonts"> +<title>Fonts</title> + +<para>This section allows you to change the type, size and character set of the +display fonts. <guilabel>Message Body</guilabel> sets the font for +the reader pane, <guilabel>Composer</guilabel> sets the font for +writing messages in the composer window.<!-- fixme in kmail: better wording? --> +There is a separate entry for <guilabel>Message List - Date Field</guilabel> +so you can choose a monospaced font for the date field for better readability.</para> + +</sect2> + +<sect2 id="configure-appearance-colors"> +<title>Colors</title> + +<para>This section allows you to change the color of the text. +<guilabel>Recycle colors on deep quoting</guilabel> means that even text that is +quoted more than three times will appear in color. Note that the +<guilabel>Quoted text</guilabel> colors only work in the message reader, not in +the composer. If you want folders which are close to their quota +(space alotment, usually used on IMAP servers) to be displayed in a different color, +you can specify a percentage value as a threshold for this. The color to be used +can be configured along with the other custom colors.<!-- TODO --></para> + +</sect2> + +<sect2 id="configure-appearance-layout"> +<title>Layout</title> + +<para><guilabel>Show HTML status bar</guilabel> activates a bar at the left side of the reader +pane that tells you if a message is &html; or not. This is important because +&html; messages might imitate the look of a signed and encrypted message, so +you should be aware of the fact that you are reading a &html; message. The &html; +status bar itself cannot be influenced by the &html; code of the message.</para> + +<para>The <guilabel>Window Layout</guilabel> section lets you choose the +layout of the main window. You can choose where you want the +<guilabel>Message Preview Pane</guilabel> or choose not to have +it at all.</para> + +<para>The <guilabel>Message Structure Viewer</guilabel> option lets you choose when +the structure viewer will be shown: the structure viewer is a part of the main window that +lets you access all parts of a message. <guilabel>Show never</guilabel> will +disable the structure viewer (note that you can still access attachments as icons), +<guilabel>Show always</guilabel> will show the structure viewer even if there is only +one plaintext part. <guilabel>Show only for non-plaintext messages</guilabel> will +display the structure viewer only if it makes sense, &ie; if the current message +has attachments or has &html; parts.</para> + +</sect2> + +<sect2 id="configure-appearance-headers"> +<title>Headers</title> + +<para>With <guilabel>Display message sizes</guilabel> selected there will be another +column in the header pane that shows the messages' size.</para> + +<para><guilabel>Show crypto icons</guilabel> will add more status information +to the <guilabel>Subject</guilabel> columns in the header pane: every message +that has been signed will have a small <guiicon>Signed</guiicon> icon in front +of the subject, every message that has been encrypted will have a small +<guiicon>Encrypted</guiicon> icon in front of the subject. Note that you have +to select a message once before these icons will appear, until then only +question marks will be displayed.</para> + +<para><guilabel>Thread list of message headers</guilabel> will put all the messages +in the header pane in a kind of tree list, so that the replies to a message are +directly below that message.</para> + +<para>With <guilabel>Message header threading options</guilabel> you can select +whether threads should appear expanded (<guilabel>open</guilabel>) by +default or whether they should be collapsed (<guilabel>closed</guilabel>). +You can of course still open/close threads using the <guilabel>+</guilabel>/<guilabel>-</guilabel> +buttons.</para> + +<para>With <guilabel>Date Display</guilabel> you can choose between several +date formats. The <guilabel>Localized Format</guilabel> is the one you can +specify under <guilabel>Country & Language</guilabel> in &kcontrol;. +For the <guilabel>Custom</guilabel> format you can get +a description of the possible values by pressing +<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo> +and then clicking on <guilabel>Custom</guilabel> option.</para> + +</sect2> + +<sect2 id="configure-appearance-systemtray"> +<title>System Tray</title> + +<para>If you enable the system tray icon then a small &kmail; icon with the +number of unread messages will be shown in the system tray. You can enable +&kmail;'s system tray icon with <guilabel>Enable system tray icon</guilabel>, +and with <guilabel>System Tray Mode</guilabel> +you can specify whether the tray icon should always be shown or only if +you have unread messages.</para> + +<para>If the icon is visible then you can hide &kmail;'s main window by +clicking on the icon or by clicking on the window close button. By clicking +on the icon you can make &kmail;'s main window visible again. +If you click on the icon with the <mousebutton>right</mousebutton> +mousebutton then you get a menu with a few useful commands. You can check +for new mail, create a new message or quit &kmail;. Additionally, there is +the entry <guilabel>New Messages In</guilabel> which lists all folders +containing unread messages. If you choose one of those folders then this +folder will be selected in &kmail;'s main window. +</para> + +</sect2> + +<!-- fixme?: date + less than/greater than broken in kmail? --> +<!-- fixme?: "group" wording in program --> + +</sect1> + + <sect1 id="configure-composer"> + <title> + Composer Page + </title> + + <sect2 id="configure-composer-general"> + <title> + General + </title> + + <variablelist> + <varlistentry id="configure-composer-general-append-signature"> + <term> + <guilabel>Automatically append signature</guilabel> + </term> + <listitem> + <para> + If checked, your signature as defined in the <link + linkend="configure-identity-signature">identity + page</link> is automatically included at the end of + all messages you create (&ie; new messages, replies, &etc;). + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-smart-quoting"> + <term> + <guilabel>Use smart quoting</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will break long lines but will try + to keep the correct quoting (⪚ the <quote>> + </quote> will always be at the start of the line). + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-auto-request-mdns"> + <term> + <guilabel>Automatically request message disposition notifications</guilabel> + </term> + <listitem> + <para> + If checked, <xref + linkend="composer-options-request-mdn"/> will default to + <emphasis>on</emphasis>. Check this option only if you + know what you are doing. &mdn;s are considered a + nuisance (or are simply ignored) by a lot of people. It + is better to decide to request them on a + message-by-message basis. + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-word-wrap"> + <term> + <guilabel>Word wrap at column</guilabel> + </term> + <listitem> + <para> + Lets you turn word wrapping on and off in the composer + window and lets you set the column at which words will + be wrapped (you probably should not need to change the + default value, which is <literal>78</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-autosave-interval"> + <term> + <guilabel>Autosave interval</guilabel> + </term> + <listitem> + <para> + A backup copy of the text in the composer window can be created + regularly. This option lets you specify the interval used to + create the backup. You can disable autosaving by setting it to + the value <literal>0</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-external-editor"> + <term> + <guilabel>External Editor</guilabel> + </term> + <listitem> + <para> + If you do not like the Composer you can use a different + editor. Note that the composer window will still open + and the external editor will open as soon as you type + just one character in the body of the message. If you are + done, save the text and exit the editor. The text will + now appear in the composer window, where you can send + it. Note that your editor may not return immediately, + you have to use ⪚ + <userinput> + <command> + gvim <option>-f</option> <varname>%f</varname> + </command> + </userinput> for <application>gvim</application>. + </para> + </listitem> + </varlistentry> + </variablelist> + + </sect2> + + +<sect2 id="configure-composer-phrases"> +<title>Phrases</title> + +<para>The <guilabel>Phrases</guilabel> tab lets you define the automatically +generated lines that are added to message replies, forwarded messages, and the +character that is added in front of quoted text. +There are special %-denoted characters that will insert certain +values, which are also displayed at the top of the <guilabel>Phrases</guilabel> section. +You can add reply phrases in languages other than +your default &kde; language using the <guibutton>Add...</guibutton> button. +You can then choose between different languages with the +<guilabel>Language</guilabel> drop down box. +This will only work for languages whose i18n package you have installed.</para> + +</sect2> + +<sect2 id="configure-composer-subject"> +<title>Subject</title> + +<para>This section contains a list of prefixes for <quote>Reply</quote> and +<quote>Forward</quote>. If you receive messages that use prefixes different +to the standard ones, you can add them here so &kmail; will recognize +them. This way &kmail; can ignore them for sorting messages and +when setting the subject of a reply or a forwarded messages, and optionally +replace them with <quote>Re:</quote> or <quote>Fwd:</quote> +respectively.</para> + +</sect2> + +<sect2 id="configure-composer-charset"> +<title>Charset</title> + +<para>Here you can manage the default charsets used for your own messages. +Every message you send will be checked if it is written in one of the listed +charsets, starting at the top of the list. If it is, this charset will be used. +If it is not, a dialog will show up and tell you that you manually have to choose +a charset using +<menuchoice><guimenu>Options</guimenu><guisubmenu>Set Encoding</guisubmenu></menuchoice>. +</para> + +<para>If you select <guilabel>Keep original charset when replying +or forwarding (if possible)</guilabel>, the original message's charset +will be kept, unless there are now characters that cannot be +represented using that charset.</para> + +</sect2> + +<sect2 id="configure-composer-headers"> +<title>Headers</title> + +<para>Check the <guilabel>Use custom message-id suffix</guilabel> +checkbox if you want &kmail; to generate Message-Id's with a custom +suffix. Enter the desired suffix in the <guilabel>Custom message-id +suffix</guilabel> field. Please make sure that the suffix that you +specify is world-wide unique. The best thing is to use the name of a +domain which you are the owner of. If you do not check <guilabel>Use +custom Message-Id suffix</guilabel> then &kmail; will automatically +generate the complete Message-Id. If you do not know what this is all +about do not check this option.</para> + +<para>The <guilabel>Define custom mime header fields</guilabel> list +sets the headers that &kmail; will use for its outgoing messages. You +can both invent new fields and overwrite existing ones. This feature +is only useful for advanced users.</para> + +</sect2> + +<sect2 id="configure-composer-attachments"> +<title>Attachments</title> + +<para>If you have to send attachments with filenames containing non-English +characters to users of Outlook(TM) or Outlook Express(TM) then you might want +to check the <guilabel>Outlook-compatible attachment naming</guilabel> option. +&kmail; will then encode the attachment names in a non-standard way that is +understood by Outlook(TM).</para> +<para>Note that &kmail; will create non-standard compliant messages, and +consequently it is possible that your messages will not be understood by +standard-compliant mail clients. So, unless you have no other choice, you +should not enable this option.</para> + +<para>Check the <guilabel>Enable detection of missing attachments</guilabel> +checkbox if you want &kmail; to warn you whenever you are about to send a +message without attachments although the message text contains certain +words which indicate that you wanted to include an attachment. The list +of key words can be modified.</para> + +</sect2> + +</sect1> + + <sect1 id="configure-security"> + <title> + Security Page + </title> + + <sect2 id="configure-security-reading"> + <title> + Reading + </title> + + <para> + On this tab you can configure security-relevant options for + reading messages. + </para> + + <variablelist> + + <varlistentry id="configure-security-reading-prefer-html"> + <term> + <guilabel>Prefer HTML to plain text</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will show &html; messages with their + &html; formatting and layout. We strongly recommend to + leave this option off, as security problems with &html; + might show up. When this option is off, you can still + read &html; messages, but only as plain text. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-reading-external-references"> + <term> + <guilabel>Allow messages to load external references from the Internet</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; can load external images, style + sheets &etc; from the Internet when you look at an + &html; message. We strongly recommend to leave this + option off (although it has no effect if you only view + plain text messages). By adding external references to + their messages, people sending spam can detect that and + when you have looked at their message. Note that this + option has no effect on &Java;, JavaScript and Plugins - + these are disabled anyway and cannot be enabled at all. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-reading-mdns"> + <term> + <guilabel>Message Disposition Notifications</guilabel> + </term> + <listitem> + <para> + &mdn;s are a generalization of what is commonly called a + <quote>read receipt</quote>. The message author requests + a disposition notification to be sent and the receiver's + mail program generates a reply from which the author can + learn what happened to his message. Common disposition + types include <quote>displayed</quote> (&ie; read), + <quote>deleted</quote> and <quote>dispatched</quote> + (⪚ forwarded). + </para> + <para> + The following options (listed as <guilabel>Send + policy</guilabel>) are available to control + <emphasis>when</emphasis> &kmail; sends &mdn;s: + </para> + <variablelist> + <varlistentry> + <term> + <guilabel>Ignore</guilabel> (recommended) + </term> + <listitem> + <para> + Ignores any request for disposition + notifications. No &mdn; will ever be sent + automatically. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <guilabel>Ask</guilabel> + </term> + <listitem> + <para> + Answers requests only after asking the user for + permission. This way, you can send &mdn;s for + selected messages while denying or ignoring them + for others. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <guilabel>Deny</guilabel> + </term> + <listitem> + <para> + Always sends a <quote>denied</quote> + notification. This is only + <emphasis>slightly</emphasis> better than always + sending &mdn;s. The author will still know that + the messages has been acted upon, he just cannot + tell whether it was deleted or read &etc; + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <guilabel>Always send</guilabel> + </term> + <listitem> + <para> + Always sends the requested disposition + notification. That means that the author of the + message gets to know when the message was acted + upon and, in addition, what happened to it + (displayed, deleted, &etc;). This option is + strongly discouraged, but since it makes sense + where privacy is not a concern, ⪚ in customer + relationship management, it has been made + available. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + If you are unsure, experiment a while with + <guilabel>Ask</guilabel> and if you find &kmail;s + questions annoying, switch to <guilabel>Ignore</guilabel>. + </para> + <para> + The following options (listed as <guilabel>Quote + original message</guilabel>) are available to control + <emphasis>how much</emphasis> of the original message + &kmail; sends back in &mdn;s. + </para> + <variablelist> + <varlistentry> + <term> + <guilabel>Nothing</guilabel> + </term> + <listitem> + <para> + No parts of the message other than the mandatory + message-id and the original recipient is included + in the &mdn; reply. This preserves enough + information for the sender to find the message in + his sent messages for which this &mdn; was + generated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <guilabel>Full message</guilabel> + </term> + <listitem> + <para> + Attaches the complete message to the disposition + notification. Usually, this is overkill. It does + not add any valueable information that cannot be + deduced from the message headers alone, but people + sometimes insist on this, since it is much easier + for humans to correlate the content of the message + than just the headers to what they sent earlier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <guilabel>Only headers</guilabel> + </term> + <listitem> + <para> + Attaches only the headers to the disposition + notification. This is usually enough to enable + both humans (by subject) and computers (by + message-id) to easily correlate &mdn; and original + message. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + If unsure, leave the option at the default. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <guilabel>Do not send MDNs in response to encrypted messages</guilabel> + </term> + <listitem> + <para> + This option suppresses the sending of &mdn;s if the + message is encrypted (partially or in whole). This + thwarts attempts to use &kmail;'s &mdn; feature as an + <emphasis>oracle</emphasis> to deduce whether you were + able to decrypt the message or not. + </para> + <para> + Strictly speaking, this option is not needed, since + &kmail; sends &mdn;s regardless of whether the message + could be successfully decrypted or not (the disposition + notification request resides in the unencrypted part of + the message), but it gives the security-conscious user + the choice to either send them always if requested + (option unchecked), or never (option checked). + </para> + <para> + If unsure, leave the option checked. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <guilabel>Automatically import keys and certificates</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; automatically imports any attachments + containing &openpgp; keys into your local keyring, and any + attachments containing &smime; keys into your local key + box. + </para> + <note> + <para> + Verifying &smime; signatures always involves importing + the contained certificates. This option thus does not + affect this. It is also unrelated to &gpg;'s + <option>auto-key-retrieve</option> feature, where &gpg; + will try to import unknown keys from a key server. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </sect2> + + <sect2 id="configure-security-composing"> + <title> + Composing + </title> + + <para> + On this tab you can configure security-relevant options for + composing messages. + </para> + + <variablelist> + + <varlistentry id="configure-security-composing-automatically-sign"> + <term> + <guilabel>Automatically sign messages</guilabel> + </term> + <listitem> + <para> + If checked, the <xref + linkend="composer-options-sign-message"/> option in the + composer will default to <emphasis>on</emphasis>. + </para> + <para> + However, you can still switch it on and off on a + per-message basis. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-composing-encrypt-to-self"> + <term> + <guilabel>Always encrypt to self</guilabel> + </term> + <listitem> + <para> + If checked, any message that is encrypted to the + recipients will additionally be encrypted to yourself. + </para> + <warning> + <para> + If you uncheck this option, you may not be able to + decrypt the messages written by yourself and encrypted + to other people anymore. + </para> + </warning> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-composing-store-sent-encrypted"> + <term> + <guilabel>Store sent messages encrypted</guilabel><!-- + --><footnote> + <para> + This options enables a mode of using mail encryption + that is sometimes (misleadingly) called + <quote>transport-only</quote> encryption. In this mode + of operation, the message encryption is stripped off + as soon as the message has reached its + destination. The encryption lasts only while the + message is on its way. + </para> + <para> + &kmail; supports this mode half-heartedly, since such + functionality should better placed at the mail + <emphasis>server</emphasis> (<acronym>MTA</acronym>) + than at the mail <emphasis>client</emphasis> + (<acronym>MUA</acronym>) level. Thus, future versions + of &kmail; may drop support for this option. + </para> + </footnote> + </term> + <listitem> + <para> + If checked, messages are stored in your + <guilabel>sent-mail</guilabel> folder just as you sent + them (&ie; if they were encrypted, they are also stored + that way). + </para> + <para> + If unchecked, messages will <emphasis>always</emphasis> + be stored unencrypted in your + <guilabel>sent-mail</guilabel> folder, even if they are + sent encrypted. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-composing-show-encryption-key"> + <term> + <guilabel>Always show the encryption keys for approval</guilabel> + </term> + <listitem> + <para> + If checked, everytime you encrypt a message, a dialog + will appear that presents you with the encryption keys + that will be used for each recipient. You can then + review the choice of keys, change them, and approve or + cancel the encryption operation. We recommend to keep + this option checked, since it makes the encryption + process more transparent. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-composing-opportunistic-encryption"> + <term> + <guilabel>Automatically encrypt messages whenever possible</guilabel> + </term> + <listitem> + <para> + Also called <quote>opportunistic encryption</quote>. If + checked, &kmail; will try to match recipients to + (&openpgp; or &smime;) keys even when you did + <emphasis>not</emphasis> specifically request + encryption. If usable keys are found for all recipients, + &kmail; will ask whether or not you want to encrypt the + message. + </para> + <para> + It is highly recommended to turn this on, as it makes + encrypting messages really easy to use. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-composing-never-sign-encrypt-drafts"> + <term> + <guilabel>Never sign/encrypt when saving as draft</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will not attempt to sign and/or + encrypt messages that are merely saved to the + <guilabel>drafts</guilabel> folder. This is more + convenient, and does not result in a gross loss of + security, provided the drafts folder is safe. &imap; + users might want this options turned off, if their + <guilabel>drafts</guilabel> folder is on the server. + </para> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> + + <sect2 id="configure-security-warnings"> + <title> + Warnings + </title> + + <para> + On this tab you can switch security-relavant warnings on and + off. + </para> + + <variablelist> + + <varlistentry id="configure-security-warnings-warn-send-unsigned"> + <term> + <guilabel>Warn when trying to send unsigned messages</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will show a warning if for whatever + reason a message would be sent without being digitally + signed. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-warnings-warn-send-unencrypted"> + <term> + <guilabel>Warn when trying to send unencrypted messages</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will show a warning if for whatever + reason a message would be sent without being encrypted. + </para> + <note> + <para> + While it is common to sign all outgoing messages, + encrypting them is not. So unless your company has a + policy of never sending any unencrypted messages, it + might be a good idea to keep this option switched off + and rely on <link + linkend="configure-security-composing-opportunistic-encryption">opportunistic + encryption</link> to alert you if you + <emphasis>could</emphasis> send encrypted messages, + but did not request it. + </para> + </note> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-warnings-warn-receiver-email-not-in-cert"> + <term> + <guilabel>Warn if receiver's email address is not in certificate</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will emit a warning if an &smime; + certifciate or &openpgp; key will be used for a recipient + whose email address is not listed in the email addresses + stored in the certificate. + </para> + <para> + Situations in which this warning will trigger include + when configuring your per-identity &openpgp; keys or + &smime; certificates, when encrypting, and when verifying + signatures, if the signature was made with a certificate + that does not include the email address of the sender. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-warnings-warn-near-expire"> + <term> + <guilabel>Warn if certificates/keys expire soon</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will warn when an &smime; certificate + or &openpgp; key is used which will expire soon. + </para> + <para> + The period in which to warn before key/certificate + expiration can then be configured separately for signing + and encryption keys, as well as (in the case of &smime;), + for end-user certificates, intermediate + <acronym>CA</acronym> certificates and root + certificates. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-security-warnings-reenable-all-warnings"> + <term> + <guilabel>Re-Enable All "Don't Ask Again" Warnings</guilabel> + </term> + <listitem> + <para> + Apart from the main warnings described above, there are + more warning and information messages, which contain an + option to not show them again. If you would like to + re-enable them after choosing not to show them again, + you can achieve this by pressing this button.<!-- + --><footnote> + <para> + This will re-enable <emphasis>all</emphasis> such + warnings for &kmail;. It does not make much sense to + allow more fine-grained selection of which warnings + to show since you can just check the option to + suppress them again when they next show up. + </para> + </footnote> + </para> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> + + <sect2 id="configure-security-smime-validation"> + <title> + &smime; Validation + </title> + + <para> + This tab contains selected entries from &gpgsm;'s <link + linkend="configure-security-crypto-backends-configure">dynamic + backend configuration dialog</link>. Please refer + to the &gpgsm; manual for a description of these options. + </para> + + <variablelist> + + <varlistentry id="configure-smime-validation-certificate-crls"> + <term> + <guilabel>Validate certificates using CRLs</guilabel> + </term> + <listitem> + <para> + If checked, &smime; certificates are validated using + Certificate Revocation Lists (<acronym>CRLs</acronym>). + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-validation-certificate-ocps"> + <term> + <guilabel>Validate certificates online (OCSP)</guilabel> + </term> + <listitem> + <para> + If this option is selected, &smime; certificates are validated + using the Online Certificates Status Protocol + (<acronym>OCSP</acronym>). + </para> + <para> + Fill in the <acronym>URL</acronym> of the <acronym>OCSP</acronym> + responder in the field reserved at this effect. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-online-certificate-responder-url"> + <term> + <guilabel>OCSP responder URL</guilabel> + </term> + <listitem> + <para> + Enter the address of the server for online validation + of certificates. The <acronym>URL</acronym> + is usually starting with <emphasis>http://</emphasis>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-online-certificate-responder-signature"> + <term> + <guilabel>OCSP responder signature</guilabel> + </term> + <listitem> + <para> + Select or change and enter the &smime; key to use. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-online-certificate-responder-ignore"> + <term> + <guilabel>Ignore service URL of certificates</guilabel> + </term> + <listitem> + <para> + Check this option to skip online validation using the OCSP. + This Option requires <emphasis>dirmngr >= 0.9.0</emphasis>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-validation-policies"> + <term> + <guilabel>Do not check certificate policies</guilabel> + </term> + <listitem> + <para> + By default, <guilabel>GnuPG</guilabel> uses the file + <emphasis>~/.gnupg/policies.txt</emphasis> to check if a + certificate policy is allowed. If this option is selected, + policies are not checked. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-validation-consult-crls"> + <term> + <guilabel>Never consult a CRLs</guilabel> + </term> + <listitem> + <para> + If this option is checked, Certificate Revocation Lists are + never used to validate <acronym>&smime;</acronym> certificates. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-validation-fetch-issuer"> + <term> + <guilabel>Fetch missing issuer certificates</guilabel> + </term> + <listitem> + <para> + Check this option if you want the missing issuer certificates + to be fetched when necessary. This applies to both validation + methods, <acronym>CRLs</acronym> and <acronym>OCSP</acronym>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-http-requests"> + <term> + <guilabel>Do not perform any HTTP requests</guilabel> + </term> + <listitem> + <para> + Entirely disables the use of <acronym>HTTP</acronym> for + <acronym>&smime;</acronym>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-http-ignore-distribution-point"> + <term> + <guilabel>Ignore HTTP CRL Distribution Point of certificates</guilabel> + </term> + <listitem> + <para> + When looking for the location of a <acronym>CRL</acronym>, + <quote>the "to-be-tested"</quote>certificate usually contains + what are known as CRL Distribution Point (<acronym>DP</acronym>) entries, + which are <acronym>URLs</acronym> describing the way to access + the <acronym>URL</acronym>. The first found <acronym>DP</acronym> + entry is used. + With this option all entries using the <acronym>HTTP</acronym> + scheme are ignored when looking for a suitable + <acronym>DP</acronym>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-http-proxy"> + <term> + <guilabel>Use system HTTP proxy</guilabel> + </term> + <listitem> + <para> + If this option is selected, the value of the + <acronym>HTTP</acronym> proxy shown on the right + (which comes from the environment variable http_proxy) + will be used for any <acronym>HTTP</acronym> request. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-http-requests-proxy"> + <term> + <guilabel>Use this proxy for HTTP requests</guilabel> + </term> + <listitem> + <para> + Enter here the location of your <acronym>HTTP</acronym> Proxy, + which will be used for all <acronym>HTTP</acronym> requests + relating to <acronym>&smime;</acronym>. + The syntax is <quote>"host:port"</quote>, for instance + <emphasis>myproxy.nowhere.com:3128</emphasis>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-ldap-requests"> + <term> + <guilabel>Do not perform any LDAP requests</guilabel> + </term> + <listitem> + <para> + Entirely disables the use of <acronym>LDAP</acronym> for + <acronym>&smime;</acronym>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-ldap-distribution-point"> + <term> + <guilabel>Ignore LDAP CRL Distribution Point of certificates</guilabel> + </term> + <listitem> + <para> + When looking for the location of a <acronym>CRL</acronym>, + the <quote>"to-be-tested"</quote> certificate usually contains + what are known as CRL Distribution Point (<acronym>DP</acronym>) entries, + which are <acronym>URLs</acronym> describing the way to access + the <acronym>URL</acronym>. + The first found <acronym>DP</acronym> entry is used. + With this option all entries using the <acronym>LDAP</acronym> + scheme are ignored when looking for a suitable + <acronym>DP</acronym>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="configure-smime-certificate-ldap-proxy-host"> + <term> + <guilabel>Primary host for LDAP requests</guilabel> + </term> + <listitem> + <para> + Entering a <acronym>LDAP</acronym> server here will make all + <acronym>LDAP</acronym> requests go to that server first. + More precisely, this setting overrides any specified host + and port part in a <acronym>LDAP URL</acronym> and will also + be used if host and port have been omitted from the + <acronym>URL</acronym>. Other <acronym>LDAP</acronym> servers + will be used only if the connection to the + <emphasis>proxy</emphasis> failed. + The syntax is <acronym>HOST</acronym> or + <acronym>HOST:PORT</acronym>. If <acronym>PORT</acronym> is + omitted, <quote>port 389</quote> + (standard <acronym>LDAP</acronym> port) is used. + </para> + </listitem> + </varlistentry> + + </variablelist> + </sect2> + + <sect2 id="configure-security-crypto-backends"> + <title> + Crypto Backends + </title> + + <para> + On this tab you can configure which crypto backends are to be + used for &openpgp; and &smime; cryptographic operations (such + as signing and encrypting). + </para> + + <para> + On the right-hand side, you see a list of available + backends. Below each backend entry, you can see what protocols + (&openpgp; and/or &smime;) the backend supports. If a protocol + is not listed, the backend does not support it. If it is + listed, but greyed out, the backend supports the protocol, but + some required programs were not found, or other errors + occurred during initialization. If you press + <guibutton>Rescan</guibutton>, a dialog box will appear that + lists reasons for the initialization failure. + </para> + + <para id="configure-security-crypto-backends-configure"> + To configure a backend, select it in the list of available + backends and press <guibutton>Configure...</guibutton>. The + per-backend configuration dialog is dynamically created from + the information returned by the backend. It may therefore + change if you update the backend applications, although + &kmail; itself is unchanged. If the + <guibutton>Configure...</guibutton> button is disabled, the + backend does not support a backend configuration dialog. + </para> + + <para> + Please refer to the manuals of the applications underlying + each backend for a description of the options presented in the + backend configuration dialogs. + </para> + + <para> + In front of each backend's protocol entries, you can see a + checkbox, with which you select which backend is to be used + for a given protocol. These checkboxes are exclusive per + protocol, meaning that if you select a backend to perform + &openpgp; operations, any previously selected &openpgp; + implementation will be unselected, but the &smime; backend + selection will be unchanged. If no backend is selected for a + given protocol, that protocol is effectively disabled for use + in &kmail;. + </para> + + </sect2> + + </sect1> <!-- configure-security --> + +<sect1 id="configure-misc"> +<title>Misc Page</title> + +<sect2 id="configure-misc-folders"> +<title>Folders</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Ask for confirmation before moving all messages to trash</guilabel></term> +<listitem> +<para>Enable this option if you want to be asked for confirmation whenever +you use <menuchoice><guimenu>Folder</guimenu><guimenuitem>Move All Messages to Trash</guimenuitem></menuchoice>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Exclude important messages from expiry</guilabel></term> +<listitem> +<para>Enable this option if important messages should never be deleted +during message expiration, &ie; during automatic deletion of old +messages.</para> +</listitem> +</varlistentry> + +<varlistentry id="configure-misc-folders-go-unread"> +<term><guilabel>When trying to find unread messages</guilabel></term> +<listitem> +<para>This option controls what happens if you press one of the shortcuts to +go to the next or previous unread message (⪚ <keycap>Space</keycap>). +If you ask &kmail; to go to the next unread message although there is no +unread message below the currently selected message then the following happens: +<itemizedlist> +<listitem> +<para>If <guilabel>Do not Loop</guilabel> is selected then nothing will happen. +</para> +</listitem> +<listitem> +<para>If <guilabel>Loop in Current Folder</guilabel> is selected then &kmail; +will search from the beginning of the current folder for an unread message. If +none is found then nothing happens.</para> +</listitem> +<listitem> +<para>If <guilabel>Loop in All Folders</guilabel> is selected then &kmail; +will first search in the current folder for another unread message. If none +is found then &kmail; will search the next folder containing unread messages. +</para> +</listitem> +</itemizedlist> +Correspondingly, if you ask &kmail; to go to the previous unread message. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Jump to first unread message when entering a folder</guilabel></term> +<listitem> +<para>If this option is enabled &kmail; will go to the first unread message +when you enter a folder; if it is not enabled, &kmail; will go to first +new message or, if there is no new message, to the message +that was selected when you last left the folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mark selected message as read after...</guilabel></term> +<listitem> +<para>When you select a <guilabel>new</guilabel> or +<guilabel>unread</guilabel> message, &kmail; will change the +message's status to <guilabel>read</guilabel> after the number of seconds +entered here. If you disable this option, messages will keep their +<guilabel>new</guilabel> or <guilabel>unread</guilabel> status.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Ask for action after dragging messages to another folder</guilabel></term> +<listitem> +<para>When you drag a message to a different folder, a small popup will ask +you if you want to move or copy the message. If you disable this option, +the message will be moved immediately, without a popup.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>By default, message folders on disk are...</guilabel></term> +<listitem> +<para>Here you can set the default <link linkend="folders-format">folder format</link> +that is used when you create a new folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Open this folder on startup</guilabel></term> +<listitem> +<para>Here you can set the folder that should be selected by default if you +start &kmail;. If you use only &imap; folders then you might want to set +this to your &imap; inbox folder. If you do that, you can collapse the local +folders in the folder list, and then they will stay collapsed when &kmail; +starts.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Empty trash on program exit</guilabel></term> +<listitem> +<para>The trash folder is cleared of messages when you quit &kmail; if this +option is selected.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="configure-misc-groupware"> +<title>Groupware</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Enable IMAP resource functionality</guilabel></term> +<listitem> +<para>Makes it possible to store the entries from the Kontact applications (KOrganizer, KAddressBook and KNotes). This option has to be set whenever you are configuring Kontact as a <guilabel>KDE Kolab client</guilabel>. This option being enabled you will also need to add the appropriate resources from the <guilabel>KDE Control Center</guilabel> (kcontrol) in the <guilabel>KDE Resources Configuration</guilabel> section. <guilabel>Kolab</guilabel> resources have to be added in case the resource functionality applies to a <guilabel>KDE Kolab client</guilabel> set-up.</para> +</listitem> +</varlistentry> +<varlistentry id="configure-misc-format-groupware-folders"> +<term><guilabel>Format used for the groupware folders</guilabel></term> +<listitem> +<para>Choose the storage format for the groupware folders</para> +<itemizedlist> +<listitem> +<para>Default format is <guilabel>Standard (Ical/Vcard)</guilabel> for calendar folders (Ical) and addressbook folders (Vcard). This makes all Kontact features available.</para> +</listitem> +<listitem> +<para><guilabel>Kolab</guilabel> users should choose <guilabel>Kolab XML</guilabel>. This format uses a custom model that matches more closely to the one used in Microsoft Outlook(tm) and gives better compatibility.</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Language of the groupware folders</guilabel></term> +<listitem> +<para>Choose between the available languages to set the folder names of the <guilabel>IMAP</guilabel> storage to your local language. Note that this option is only aimed for compatibility with Microsoft Outlook(tm). It is not recommended to change its default unless you have to, since it makes changing languages impossible.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Resource folders are in account</guilabel></term> +<listitem> +<para>Select the parent of the <guilabel>IMAP</guilabel> resource folders. You should select the name of your <guilabel>IMAP/DIMAP</guilabel> account. By default the <guilabel>Kolab</guilabel> server sets the <guilabel>IMAP</guilabel> inbox to be the parent.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Hide groupware folders</guilabel></term> +<listitem> +<para>You should not need to see the folders that hold the <guilabel>IMAP</guilabel> resources. However if you want to see them, you can set that by enabling this option.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Mangle From:/To: headers in replies to invitations</guilabel></term> +<listitem> +<para>Enable this option to make Microsoft Outlook(tm) understand your answers to invitations replies.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Send invitations in the mail body</guilabel></term> +<listitem> +<para>Invitations use to be send as attachments to a mail. By enabling this option, you let the invitation mails to be sent in the text of the mail, which is necessary to send invitations and replies to Microsoft Outlook(tm).</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="configure-non-gui-options"> +<title>Options without a user interface representation</title> +<para> +Apart from the options presented in the configuration dialog, some options +can only be set directly in the configuration file ($KDEHOME/share/config/kmailrc) +or through KIOSK. +</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Send Message Distribution Notifications with an empty sender string (SendMDNsWithEmptySender)</guilabel></term> +<listitem> +<para> +Send Message Disposition Notifications with an empty sender string. Some servers might be configured to reject +such messages, so if you are experiencing problems sending MDNs, make sure this option is set to false. To +enable this feature, add a line reading: + +SendMDNsWithEmptySender=true + +to the [MDN] section of the kmail configuration file. If there is no such section, simply add "[MDN]" on +a line by itself just above the option. + +Note that the default setting of "false" strictly speaking violates internet standards, but is +set that way for practical reasons, to avoid servers rejecting MDNs that KMail generates because they +think they are SPAM. +</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow Semicolon As EMail Address Separator (AllowSemicolonAsAddressSeparator)</guilabel></term> +<listitem> +<para> +In RFC2822, the comma (,) is the only allowed separator for email addresses in fields like To, CC and BCC. This option allows to also use the semi-colon (;) as separator. This only affects the user interface, the created messages still use commas only and thus do no violate the standard. + +The option is enabled by default. To disable the feature, add a line reading (under [Composer] section): +</para> +<programlisting>AllowSemicolonAsAddressSeparator=false +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>ForwardingInlineByDefault</guilabel></term> +<listitem> +<para> +This option allows you to make inline forwarding the default forwarding method instead +of forwarding as attachement. + +To enable the feature, add a line reading (under [Composer] section): +</para> +<programlisting>ForwardingInlineByDefault=true +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>MaximumAttachmentSize</guilabel></term> +<listitem> +<para> +This allows the maximum file size allowed for attachments in the mail +composer to be limited. + +To limit attachments to 20 MB ins size, for example, add a line reading (under [Composer] section): +</para> +<programlisting>MaximumAttachmentSize=20 +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>CloseDespiteSystemTray</guilabel></term> +<listitem> +<para> +This option allows you to configure the application to close fully, even if there +is a system tray icon configured, which would normally keep the application running. + +To enable the feature, add a line reading (under [General] section): +</para> +<programlisting>CloseDespiteSystemTray=true +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>CheckOutOfOfficeOnStartup</guilabel></term> +<listitem> +<para> +With this option enabled, KMail will check on every startup if there is an +active out-of-office configured and show a warning if this is the case. + +To disable the feature, add a line reading (under [OutOfOffice] section): +</para> +<programlisting>CheckOutOfOfficeOnStartup=false +</programlisting> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guilabel>disregardUmask</guilabel></term> +<listitem> +<para> +This option allows you to disregard the users umask setting and use "read-write for the user only". + +To enable the feature, add a line reading (under [General] section): +</para> +<programlisting>disregardUmask=false +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>AutoLostFoundMove</guilabel></term> +<listitem><para>Activate this option to automate the handling of not yet uploaded messages in disconnected IMAP +folders that can not be uploaded. This can happen if the folder was removed from the server or your access +rights have been restricted. Such messages will automatically moved to a newly created lost+found folder if +this option is enabled, you will be ask how to proceed everytime otherwise. + +To enable the feature, add a line reading: +</para> +<programlisting>AutoLostFoundMove=true</programlisting> +<para>to the [Behaviour] section of the configuration file </para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + + +</sect1> + +</chapter> diff --git a/doc/kmail/credits-and-licenses.docbook b/doc/kmail/credits-and-licenses.docbook new file mode 100644 index 000000000..ec986f5cf --- /dev/null +++ b/doc/kmail/credits-and-licenses.docbook @@ -0,0 +1,153 @@ +<chapter id="credits-and-licenses"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-13</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Credits and Licenses</title> + +<para>&kmail;: Copyright the &kmail; developers, 1997-2004</para> + +&underGPL; +&underFDL; + +<sect1 id="team"> +<title>Development Team</title> +<!-- please keep in sync with the authors list on the webpage --> + +<!-- don't modify manually, this list is generated: --> +<itemizedlist> +<listitem><para>Ingo Klöcker (kloecker at kde org): Maintainer</para></listitem> +<listitem><para>Don Sanders (sanders at kde org): Adopter and co-maintainer</para></listitem> +<listitem><para>Stefan Taferner (taferner at kde org): Original author</para></listitem> +<listitem><para>Michael Häckel (haeckel at kde org): Former maintainer</para></listitem> +<listitem><para>Till Adam (till at adam-lilienthal de): Core developer</para></listitem> +<listitem><para>Carsten Burghardt (burghardt at kde org): Core developer</para></listitem> +<listitem><para>Marc Mutz (mutz at kde org): Core developer</para></listitem> +<listitem><para>Daniel Naber (daniel naber at t-online de): Documentation</para></listitem> +<listitem><para>Zack Rusin (zack at kde org): Core developer</para></listitem> +<listitem><para>Toyohiro Asukai (toyohiro at ksmplus com)</para></listitem> +<listitem><para>Waldo Bastian (bastian at kde org)</para></listitem> +<listitem><para>Ryan Breen (ryan at ryanbreen com): system tray notification</para></listitem> +<listitem><para>Steven Brown (swbrown at ucsd edu)</para></listitem> +<listitem><para>Matthias Kalle Dalheimer (kalle at kde org)</para></listitem> +<listitem><para>Cristi Dumitrescu (cristid at chip ro)</para></listitem> +<listitem><para>David Faure (faure at kde org)</para></listitem> +<listitem><para>Philippe Fremy (pfremy at chez com)</para></listitem> +<listitem><para>Kurt Granroth (granroth at kde org)</para></listitem> +<listitem><para>Andreas Gungl (a gungl at gmx de): PGP 6 support and further enhancements of the encryption support</para></listitem> +<listitem><para>Steffen Hansen (hansen at kde org)</para></listitem> +<listitem><para>Igor Janssen (rm at linux ru net)</para></listitem> +<listitem><para>Matt Johnston (matt at caifex org)</para></listitem> +<listitem><para>Christer Kaivo-oja (whizkid at telia com)</para></listitem> +<listitem><para>Lars Knoll (knoll at kde org): Original encryption support, PGP 2 and PGP 5 support</para></listitem> +<listitem><para>J. Nick Koston (bdraco at darkorb net): GnuPG support</para></listitem> +<listitem><para>Stephan Kulow (coolo at kde org)</para></listitem> +<listitem><para>Guillaume Laurent (glaurent at telegraph-road org)</para></listitem> +<listitem><para>Sam Magnuson (sam at trolltech com)</para></listitem> +<listitem><para>Laurent Montel (lmontel at mandrakesoft com)</para></listitem> +<listitem><para>Matt Newell (newellm at proaxis com)</para></listitem> +<listitem><para>Denis Perchine (dyp at perchine com)</para></listitem> +<listitem><para>Samuel Penn (sam at bifrost demon co uk)</para></listitem> +<listitem><para>Carsten Pfeiffer (pfeiffer at kde org)</para></listitem> +<listitem><para>Sven Radej (radej at kde org)</para></listitem> +<listitem><para>Mark Roberts (mark at taurine demon co uk)</para></listitem> +<listitem><para>Wolfgang Rohdewald (wrohdewald at dplanet ch)</para></listitem> +<listitem><para>Espen Sand (espen at kde org)</para></listitem> +<listitem><para>Aaron J. Seigo (aseigo at olympusproject org)</para></listitem> +<listitem><para>George Staikos (staikos at kde org)</para></listitem> +<listitem><para>Jason Stephenson (panda at mis net)</para></listitem> +<listitem><para>Jacek Stolarczyk (jacek at mer chemia polsl gliwice pl)</para></listitem> +<listitem><para>Roberto S. Teixeira (maragato at kde org)</para></listitem> +<listitem><para>Bo Thorsen (bo at sonofthor dk)</para></listitem> +<listitem><para>Ronen Tzur (rtzur at shani net)</para></listitem> +<listitem><para>Mario Weilguni (mweilguni at sime com)</para></listitem> +<listitem><para>Wynn Wilkes (wynnw at calderasystems com)</para></listitem> +<listitem><para>Robert D. Williams (rwilliams at kde org)</para></listitem> +<listitem><para>Markus Wübben (markus wuebben at kde org)</para></listitem> +<listitem><para>Karl-Heinz Zimmer (khz at kde org)</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="credits"> +<title>Credits</title> + +<itemizedlist> +<listitem><para>Heiko Hund (heiko at ist eigentlich net): POP filters</para></listitem> +<listitem><para>Bernhard Reiter (bernhard at intevation de): Ägypten and Kroupware project management</para></listitem> +<listitem><para>Jan Simonson (jan at simonson pp se): beta testing of PGP 6 support</para></listitem> +<listitem><para>Patrick S. Vogt (patrick vogt at unibas ch): timestamp for 'Transmission completed' status messages</para></listitem> +<listitem><para>Jan-Oliver Wagner (jan at intevation de): Ägypten and Kroupware project management</para></listitem> +<listitem><para>Wolfgang Westphal (wolfgang westphal at gmx de): multiple encryption keys per address</para></listitem> +<listitem><para>Thorsten Zachmann (t zachmann at zagge de): POP filters</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="documentation"> +<title>Documentation</title> + +<para>Update for &kmail; 1.7 by +Ingo Klöcker <email>kloecker@kde.de</email> and +Marc Mutz <email>mutz@kde.org</email>, +Anti-Spam Wizard chapter by Andreas Gungl <email>a.gungl@gmx.de</email>, +section about filter log by Andreas Gungl <email>a.gungl@gmx.de</email> and +Brad Hards <email>bradh@frogmouth.net</email>, +additional changes by Daniel Naber <email>daniel.naber@t-online.de</email>.</para> + +<para>Update for &kmail; 1.2 to 1.5 by Daniel Naber +<email>daniel.naber@t-online.de</email>, +<application>OpenPGP</application> chapter by Andreas Gungl +<email>a.gungl@gmx.de</email> and Ingo Klöcker <email>kloecker@kde.de</email>, +message filter chapter by Marc Mutz +<email>mutz@kde.org</email>, download filter chapter by Thorsten +Zachmann <email>T.Zachmann@zagge.de</email>. Other parts have been +contributed by various &kmail; developers.</para> + +<para>&kmail; 1.0 +documentation by David Rugge <email>davidrugge@mediaone.net</email>. +Original documentation by Markus Wuebben +<email>markus.wuebben@kde.org</email>, Robert Williams +<email>rwilliams@kde.org</email> (Editor).</para> + +<para>Thanks to Michael Elkins <email>me@cs.hmc.edu</email> for his excellent +description of the different &UNIX; mail formats in the <application>Mutt</application> +documentation.</para> + +<para>Thanks to the following people for providing directions on using other +email client mailboxes with &kmail;:</para> + +<itemizedlist> +<listitem><para>Nik Gaffney <email>nik@f0.am</email> +(<application>Mailsmith</application>)</para></listitem> +<listitem><para>David McMillen <email>mcmillen@math.bu.edu</email> and +Mendel Mobach <email>mendel@mobach.nl</email> (&Netscape; mail)</para></listitem> +<listitem><para>Ed Shapard <email>shapard@bigfoot.com</email> +(<application>Pegasus</application> Mail)</para></listitem> +<listitem><para>Ray Muir <email>rjmuir@ibm.net</email> (Forte +<application>Agent</application>)</para></listitem> +</itemizedlist> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect1> +</chapter> diff --git a/doc/kmail/faq.docbook b/doc/kmail/faq.docbook new file mode 100644 index 000000000..f7ef1e682 --- /dev/null +++ b/doc/kmail/faq.docbook @@ -0,0 +1,590 @@ +<chapter id="faq"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-14</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Frequently Asked Questions (&FAQ;)</title> +<!-- TODO: split into categories? unfortunately this will produce several files, eg. with <section> --> + +<qandaset id="faq-set"> + +<!-- fixme: how to use old kmail mail data: copy files from +~/Mail (incl. hidden ones) to the new ~/Mail folder --> + +<qandaentry> +<question><para>Why are my filters not applied to incoming messages of &imap; accounts?</para></question> +<answer> +<para>Normal &imap; mode does not support filtering, but the new +disconnected &imap; account type does. You could try to use server-side +filtering (ask your admin for how to install filters on the server and in +which format), since &imap; is all about managing your email <emphasis>on the server</emphasis>. +Unfortunately, although there exists a mail filter language (Sieve, defined +in RFC3028), there is no standardized access protocol for installing or +editing server-side Sieve scripts. If such a protocol becomes available in +the future, &kmail; will most probably include support for it.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Using <application>PGP</application> or <application>GnuPG</application> +is very slow or it blocks &kmail;.</para></question> +<answer> +<para>&kmail; accesses <application>PGP</application>/<application>GnuPG</application> +synchronously, &ie; it blocks while <application>PGP</application>/<application>GnuPG</application> +works. This means that you might want to disable automatic retrieval +of unknown keys from a keyserver to make &kmail; look more responsive. +If you are using <application>GnuPG</application> 1.0.7 (or better) or upgraded from an earlier +version, then make sure to run <command>gpg <option>--rebuild-keydb-caches</option></command> +once and <command>gpg <option>--check-trustdb</option></command> after every import or refresh. +Both will speed up <application>GnuPG</application> immensely.</para> +</answer> +</qandaentry> + +<qandaentry id="pgp-faq"> +<question><para>What should I know if I want to use +<application>PGP</application>/<application>GnuPG</application> with +&kmail;?</para></question> + +<answer><para>&kmail; provides a simple and easy-to-use interface for the basic + functions of these programs; still you should understand how these programs + work and what might make their use insecure. Some important issues:</para> + +<itemizedlist> +<listitem> +<para>You <emphasis>really</emphasis> should test if encryption works +before you use it. &kmail; partly relies on +<application>PGP</application>/<application>GnuPG</application>'s error strings, +which often change between different versions.</para> +</listitem> +<listitem> +<para>&kmail; will not encrypt messages with an untrusted (unsigned) public key: if you want to encrypt to such a +key you should check the identity of the key owner and only then sign the key +with your secret key; if you do not want to or cannot check the identity +of the key owner but nevertheless want to encrypt the message then +please sign the key locally with <userinput><command>gpg</command> +<option>--lsign</option> <replaceable>keyID</replaceable></userinput>.</para> +</listitem> +<listitem> +<para>Trusting a foreign public key without checking it is not a good idea.</para> +</listitem> +<listitem> +<para>&kmail; cannot encrypt and sign attachments if you are using +the built-in OpenPGP support. For encrypted and signed attachments you need +to have <link linkend="configure-security-crypto-backends">crypto +plugins</link> installed and configured.</para> +</listitem> +<listitem> +<para>Starting with GnuPG 1.0.7 you have to set your own key to +ultimate ownertrust: it is no longer implicitly done for you.</para> +</listitem> +</itemizedlist> +</answer> +</qandaentry> + +<qandaentry> <question><para>Where does &kmail; save my settings and my +mail?</para></question> <answer> <para>Most &kmail; settings are stored in +<filename>$<envar>KDEHOME</envar>/share/config/kmailrc</filename>, where +$<envar>KDEHOME</envar> is typically <filename +class="directory">~/.kde</filename>; the identities are stored in +<filename>$<envar>KDEHOME</envar>/share/config/emailidentities</filename> +and your mail is saved in <filename +class="directory">$<envar>KDEHOME</envar>/share/apps/kmail</filename> (or +<filename class="directory">~/Mail</filename> if you upgraded from a +previous &kmail; version that used this location.) Note that some of the +files are hidden: remember to also copy those if you want to backup or +archive your mails.</para> </answer> </qandaentry> + +<qandaentry id="faq-index-regeneration"> +<question><para>Why did &kmail; regenerate the index of a folder?</para></question> +<answer> +<para>&kmail; regenerates the index of a folder whenever the index appears to be +out of date, &ie; whenever the contents of a folder are newer than the +index. &kmail; regenerates the index in this case in order to prevent +the loss or corruption of messages. Unfortunately, currently-deleted +messages might reappear and message flags (like important, etc.) might +be lost when the index is regenerated.</para> +<para>An outdated index can have several causes; the two most important causes +are: +<itemizedlist> +<listitem><para>Some other program modified the contents of the folder: if you want +to use &kmail; together with procmail then please read <link + linkend="faq-procmail">this &FAQ;</link>. If you want to use &kmail; together with +another email client then please read <link +linkend="faq-other-muas">this &FAQ;</link>.</para></listitem> +<listitem><para>If your mail folder (usually <filename class="directory">$<envar>KDEHOME</envar>/share/apps/kmail/</filename> or <filename class="directory">~/Mail</filename>) +is on a volume which is mounted via NFS and if the clock of the NFS server is ahead of the +clock of your computer then the NFS server sometimes reports a wrong +file date for the index file. In this case &kmail; assumes that the index +is outdated although in reality it is not. To fix this problem +you (or your system administrator) have to make sure that the clock of +the NFS server and the clock of your computer are always in sync. One +way to achieve this is the use of the ntp daemon.</para></listitem> +</itemizedlist> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>I cannot add addresses to my address book after upgrading to KDE 3.x.</para></question> +<answer> +<para>You probably copied your old <filename>kmailrc</filename> file manually. That is not +necessary, there is a script that will do such things when you run KDE 3.x +for the first time. To fix the problem, remove the complete <quote>[AddressBook]</quote> +group and the addressbook option in group <quote>[General]</quote> in your +<filename>kmailrc</filename> file; however, chances are you will also encounter other problems +that the config update script would have solved.</para> +</answer> +</qandaentry> + +<qandaentry id="faq-other-muas"> +<question><para>Can I use &kmail; together with a different email client, ⪚ +<application>mutt</application>?</para></question> +<answer> +<para>If you're using the mbox format for your folders it is not +possible to use a different email client while &kmail; is running. +With <application>mutt</application> there may also be problems +even if both programs are not running at the same time. We recommend to +use the maildir format in this case, this should solve all problems.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I convert my mailboxes from mbox to maildir?</para></question> +<answer> +<para>There is no automatic way to do that. You will have to create a new folder +in maildir format and copy the messages from the mbox folder into this +new folder. Remember to adapt any filter rules connected with the old folder before +you delete it.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I use a browser other than &konqueror; to +open links in messages?</para></question> +<answer> +<para>Change the <guilabel>File Associations</guilabel> for HTML files +using &kcontrol;.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I remove attachments from messages without removing +the message itself?</para></question> +<answer> +<para>This is currently not supported. As a workaround, move the +message to the drafts folder, double click on it in order to open +it in the composer, remove the attachments, save the message again to the +drafts folder, move it back to its folder. The disadvantage of +this workaround is that the date will be changed to the current date. +Some other headers might also be changed.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I make &kmail; check for new messages at startup?</para></question> +<answer> +<para>If &kmail; should always check for new messages at startup then +enable <guilabel>Check mail on startup</guilabel> on the +<link linkend="configure-accounts-receiving">Accounts configuration page</link>. +Otherwise start &kmail; with <command>kmail <option>--check</option></command>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Why does &kmail; get slow / stop working when I try to +send big attachments?</para></question> +<answer> +<!-- fixme: update for 3.2 --> +<para>&kmail; is known to have problems with large attachments. We are working +on a solution for this problem for &kde; 3.2 but currently it temporarily consumes +virtual memory of about 10-15 times the size of the attachment. That +means that if you attach a 2MB file &kmail; might temporarily need about +20-30 MB of virtual memory (= RAM + swap space). If you do not have +enough virtual memory this will lead to problems.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Where can I get a list of changes between the versions of &kmail;?</para></question> +<answer> +<para>The welcome screen lists all important changes for your version. It is displayed when you +select <menuchoice><guimenu>Help</guimenu><guimenuitem>&kmail; Introduction</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Can I configure the location of my mail folder?</para></question> +<answer> +<para>Exit &kmail;, make a backup of <filename>~/.kde/share/config/kmailrc</filename>, +then open it with an editor and add ⪚ <userinput>folders=/home/username/.mail</userinput> +to the <quote>[General]</quote> section. Then move all your existing folders (including +the hidden index files) to the new location. The next time you start &kmail; will use +<filename class="directory">/home/username/.mail</filename> instead of +<filename class="directory">/home/username/.kde/share/apps/kmail</filename>. Note that &kmail; +will lose its filters if you change the mail folder's location but forget +to move your existing folders.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I use mail folders that are not in the normal &kmail; message folder location?</para></question> + +<answer><para>To add a whole mbox mail folder use +<userinput><command>ln</command> <option>-s</option> +<filename>/somewhere/Mail/.remotedir.directory</filename> <filename +class="symlink">/home/username/share/apps/kmail/.mymailboxfile.directory</filename></userinput>. +Note that it is not possible to use links to files, only links that point +to folders will work.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>I'm one of those people whose mails consist of 100 quoted lines +and one line written by myself. For some reason this annoys other people. Can +&kmail; help me and make everyone's life better?</para></question> +<answer><para>Sure. Just select a short relevant part of the original mail +with the mouse before you reply. Only this part will then be quoted in your +reply.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>For some messages the value in the <guilabel>Date</guilabel> field +is <guilabel>unknown</guilabel> or it is not correct.</para></question> +<answer><para>Probably the <quote>Date:</quote> header of these messages is +broken and &kmail; cannot interpret it. That is not a bug in &kmail; +but in the software that sent the mail.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>My signature has two dashes above it. What's up?</para></question> +<answer> +<para> +Separating the signature from the message body with two dashes and a space +on a single line is common usage. These symbols permit mail clients who recognize +them to trim the signatures from a reply. If your signature does not already have +this separator, &kmail; will automatically add it.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>&kmail; fetches the same messages over and over again.</para></question> +<answer><para>This happens if you have enabled +<guilabel>Leave fetched messages on the server</guilabel> +and your POP3 server does not support the UIDL command. There is currently +no workaround besides disabling +<guilabel>Leave fetched messages on the server</guilabel>. +A more detailed explanation can be found +<ulink url="http://lists.kde.org/?l=kmail&m=99220697415300&w=2">in this +mailing list post</ulink>.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>Are there any known bugs in &kmail;?</para></question> +<answer> +<para>A list of submitted bugs is linked at <ulink +url="http://kmail.kde.org/">the &kmail; homepage</ulink>. Note that not all +these bugs are valid. All in all we think that &kmail; is a very robust piece +of software.</para> +<para><warning><para>However, you should not run &kmail; while another email client is already +accessing the files in <filename class="directory">~/Mail</filename>; if you try to do so, +you might lose messages. Note that you should make backups of your messages anyway.</para></warning></para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>&kmail; does not display <acronym>HTML</acronym> mail properly.</para></question> +<answer><para>References to external content like images, are disabled by +default, as they can be used to track whether and when you read a message. +Loading external references can be activated in the <guilabel>Security</guilabel> +tab in &kmail;'s configuration dialog; also Plugins (like <trademark +class="registered">Macromedia</trademark> <application>Flash</application>), +&Java; and JavaScript will not be displayed in &kmail; for security reasons +and there is no way to activate them.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>Can I use two different versions of &kmail; at the same time? Can I go +back from a current version of &kmail; to an older one?</para></question> +<answer><para>You can only run one instance of &kmail; at once. We also recommend +to stick to a certain version and not switch back and forth between different versions. +Downgrading to an older version will probably cause problems, ⪚ because the index file +formats might have changed. Upgrading should never be a problem.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>Does &kmail; support uuencoded files?</para></question> +<answer><para>Uuencoded attachments are supported, but inline uuencoded files are not.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>&kmail; crashed while I was writing a mail; is that mail is lost now?</para></question> +<answer><para>&kmail; tries to save your mail to +<filename>~/dead.letter</filename> in case of a crash. The next time you start +&kmail; the mail composer should appear with your mail again; If it does not, +try to open <filename>~/dead.letter</filename> with an editor. If it does not +exist then the crash was so bad that &kmail; could not save your mail.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>When I try to set a folder to be mailing list-aware, it does not do +anything when receiving an email from the list.</para></question> +<answer><para>Associating a folder with a mailing list has nothing to do with +filtering the mailing list messages — you have to add a new filter rule manually; however, once you associated a folder with a mailing list you can use <menuchoice> +<guimenu>Message</guimenu><guimenuitem>Reply to Mailing-List...</guimenuitem></menuchoice> or +<menuchoice><guimenu>Message</guimenu><guimenuitem>New Message to Mailing-List...</guimenuitem></menuchoice> +and the mailing list address will be set in the <guilabel>To:</guilabel> field. +</para></answer> +</qandaentry> + +<qandaentry> +<question><para>My SMTP server requires authentication; Does &kmail; support this?</para></question> +<answer><para>There are two common techniques used for <acronym>SMTP</acronym> authentication: +<quote>SMTP after POP3</quote> and <quote>SMTP Auth</quote>. +<quote>SMTP Auth</quote> can be set in the <guilabel>General</guilabel> tab +of the SMTP configuration dialog. +To use <quote>SMTP after POP3</quote> you have to collect all your messages in the +<guilabel>outbox</guilabel> and send them just after you have fetched new mail. +You can make &kmail; send the queued messages automatically with the +<guilabel>Send messages in outbox folder</guilabel> option on the +<link linkend="configure-accounts-sending">Accounts configuration page</link>. +</para></answer> +</qandaentry> + +<qandaentry id="faq-procmail"> +<question><para>Can I use &kmail; and <application>procmail</application>?</para></question> +<answer><para>Yes, but it is important to do it the right way or you might lose +mail. In order to use <application>procmail</application> and &kmail; you need +to set up &kmail; so that it will fetch new +mail from the spoolfiles in which <application>procmail</application> +drops your mail. Do <emphasis>not</emphasis> set up procmail to deliver +mail in a &kmail; folder, this cannot work.</para> + +<para>For each procmail spoolfile you then need to create an account +from which &kmail; will fetch new mail; you also need to make sure you +specify the right lockfile name for this account. When setting up an +account, &kmail; will do some minimal parsing on your +<filename>.procmail</filename> file, and will try to list every +spoolfile it has found, and also the lockfiles next to the +<guilabel>procmail lockfile</guilabel> item. procmail lets the user +specify lockfiles in three different ways, so there is no way to +establish a correspondence between the spoolfiles and lockfiles; so it's +really up to you to make sure you specify the right lockfile for each +spoolfile.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Spellchecking does not recognize non-English +characters.</para></question> +<answer><para>Before you can use spellchecking the first time, you have to +configure it. You can do so in the composer window's menu +under <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Spellchecker...</guimenuitem></menuchoice>. You can set +the dictionary and the encoding there.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>How do I use my +<application>Eudora</application>/&Netscape;/<application>Outlook</application>/... +mail folders in &kmail;?</para></question> +<answer><para>See the section <link linkend="importing">Using other Mailbox +files With &kmail;</link>.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>Can I use encryption with my normal (non-<acronym>SSL</acronym>) +POP3 account?</para></question> +<answer><para>If your POP3 server runs an +<application>ssh</application> daemon, you can use ssh to tunnel your +POP3 connection using the following command:</para> + +<para><userinput><command>ssh</command> <option>-L 11000:127.0.0.1:110 +user@host</option></userinput></para> + +<para>Modify your &kmail; configuration to fetch the mail via +POP3 from <userinput>localhost</userinput> and ssh will tunnel +the connection for you. + +<note><para>If non-encrypted messages have already been sent +via Internet, the only advantage of using <application>ssh</application> is +that your <emphasis>password</emphasis> will be sent encrypted to the POP3 +server.</para></note> + +<!-- fixme: add link to http://www.linuxdoc.org/HOWTO/mini/Secure-POP+SSH.html --> + +</para> +</answer> +</qandaentry> + +<qandaentry id="faq-file-locking"> +<question><para>Does &kmail; lock the folders it uses?</para></question> +<answer><para>&kmail; does not lock the files in <filename +class="directory">~/Mail</filename>.</para> +<para>To avoid the risk of losing mail <emphasis>if using a local +account</emphasis> it is necessary to ensure that &kmail; uses the same type of +locking as your mail delivery agent.</para> + +<para>There are five different locking options you can use:</para> + +<itemizedlist> +<listitem><para><guilabel>Procmail lockfile</guilabel></para></listitem> +<listitem><para><guilabel>Mutt dotlock</guilabel></para></listitem> +<listitem><para><guilabel>Mutt dotlock privileged</guilabel></para></listitem> +<listitem><para><guilabel>FCNTL</guilabel> (default)</para></listitem> +<listitem><para><guilabel>none (use with care)</guilabel></para></listitem> +</itemizedlist> + +<para><guilabel>Procmail lockfile</guilabel> will use a small utility that comes +with <application>procmail</application> called <command>lockfile</command>. You +can use this if your mail folder is in a folder where you have write +permission. This will not work on your <filename +class="directory">/var/spool/mail/user</filename> file in most cases. It will +create <filename>.lock</filename> files on your account when &kmail; is checking +for new mail. Please note that this will only work if +<application>procmail</application> is installed on your system.</para> + +<para><guilabel>Mutt dotlock</guilabel> and <guilabel>Mutt dotlock +privileged</guilabel> will both use a small utility that comes with +<application>mutt</application> +called <command>mutt_dotlock</command>. <guilabel>Mutt dotlock</guilabel> +can be used in the same way as the <guilabel>Procmail lockfile</guilabel> +option, with the same limitation with regards to the <filename +class="directory">/var/spool/mail/</filename> folders. However, the +<guilabel>Mutt dotlock privileged</guilabel> option can create lock files +in the <filename class="directory">/var/spool/mail</filename> folder. +<command>mutt_dotlock</command> is a setgid program and this option will +run it in setgid mode. Please note that these options will only work if +<application>mutt</application> is installed on your system.</para> + +<para><guilabel>FCNTL</guilabel> will use the +<function>fcntl()</function> system call.</para> + +<warning><para>Usage of FCNTL locking might cause system lockups when the mail +spool file is on an NFS mounted device.</para></warning> + +<para>If you do not want to use any locking, the <guilabel>none</guilabel> option +is what you want. However, there are risks of losing mail when no locking is +used.</para> + +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I leave messages on the server?</para></question> +<answer><para>See the <link linkend="popfilters">Download filters</link> chapter. +If you want to leave all messages on the server: open up the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kmail;...</guimenuitem> +</menuchoice> window. Click on the <guilabel>Network</guilabel> page. Select your +account from the account list and click the <guibutton>Modify...</guibutton> +button. This dialog contains the <guilabel>Leave fetched messages on the server</guilabel> +setting which you must enable.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>How do I automatically insert a text footer within my +messages?</para></question> +<answer><para>The text footer is also called a signature (not to be confused +with a cryptographic signature). Select +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kmail;...</guimenuitem></menuchoice> +Look in the <guilabel>Identity</guilabel> page for the <guilabel>Signature</guilabel> +tab and add your signature there. Then go to the <guilabel>General</guilabel> +tab on the <guilabel>Composer</guilabel> page and enable +<xref linkend="configure-composer-general-append-signature"/></para></answer> +</qandaentry> + +<qandaentry> +<question><para>How do I set up &Sendmail; to work with +&kmail; if I have a dial-up connection?</para></question> + +<answer><para>First you should check if your distribution +can do this for you. It probably has already been set up during +installation.</para> + +<para>If that is not the case, you may want to have a look at <ulink +url="http://en.tldp.org/HOWTO/mini/Mail-Queue.html">the Mail Queue +HOWTO</ulink>.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>I've seen demonstrations of remote control behavior with &kmail;. +Is there any documentation on the available interfaces?</para></question> +<answer><para>You can get a list of functions by using this command in a shell: +<userinput><command>dcop</command> +<option>kmail KMailIface</option></userinput>. Some documentation is also +available in <filename>kdenetwork/kmail/kmailIface.h</filename> and +<filename>kdenetwork/kmail/mailcomposerIface.h</filename>.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>When I reply to a message, only a part of the message is quoted. How come?</para></question> +<answer><para>This can happen when the message contains two dashes and a space on a single line. This is seen as the start of the signature. The remaining part of the message will not be quoted, because when you reply to a message KMail strips the signature.</para></answer> +</qandaentry> + + +<qandaentry> +<question><para>I am only using &imap;, can I get rid of those Local Folders in +the folder list or at least keep them collapsed all the time?</para></question> +<answer><para>No you can not get rid of them. The local folders function as a +fallback when the &imap; server is unreachable. Although you only use &imap;, +&kmail; uses the outbox for sending the messages. If we hide all local folders +you won't be able to fix messages in the outbox which can not be send for some +reason. But it is possible to keep the local folders collapsed. What +you have to do is go to <menuchoice><guimenu>Settings</guimenu><guimenuitem> +Configure &kmail;...</guimenuitem></menuchoice> and go to the section Misc, +there you can setup the folder on startup. If you change that to a folder on +the &imap; account, the Local Folders will stay collapsed when &kmail; starts. +</para></answer> +</qandaentry> + <qandaentry id="faq-decrypt-on-read"> + <!-- ideally, this should be in the documentation of the --> + <!-- reader window, but oops, there's no documentation of --> + <!-- the reader window >:-( (mmutz) --> + <question> + <para> + How do I enable permanent decryption of read messages? + </para> + </question> + <answer> + <para> + The global reversal of encryption is considered extremely + insecure. Shared access to messages for multiple persons + should be implemented using semantic solutions (⪚ by + defining roles like <quote>department + manager</quote>). + </para> + <para> + In case it is imperative to use it in the insecure mode, it + has to be manually enabled in the file + <filename>$KDEHOME/share/config/kmailrc</filename> by adding + the following directive in the <literal>[Reader]</literal> + group: + <programlisting> + store-displayed-messages-unencrypted=true + </programlisting> + </para> + </answer> + </qandaentry> + + +</qandaset> + +</chapter> diff --git a/doc/kmail/getting-started.docbook b/doc/kmail/getting-started.docbook new file mode 100644 index 000000000..c70249e7c --- /dev/null +++ b/doc/kmail/getting-started.docbook @@ -0,0 +1,329 @@ +<chapter id="getting-started"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<author> +<firstname>Michel</firstname> +<surname>Boyer de la Giroday</surname> +<affiliation><address> +<email>michel@klaralvdalens-datakonsult.se</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-13</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Getting Started</title> + +<para>This is a short introduction to &kmail; and its usage so you can +start working with it right away. For more in-depth information see the +<link linkend="using-kmail">Using &kmail;</link> section. Note that +&kmail;'s installation is described in <link linkend="installation">the +appendix</link>.</para> + +<para>Invoking &kmail; for the first time creates a folder called +<filename class="directory">Mail</filename> in your home folder. +This folder contains the initial folders +(<filename class="directory">inbox</filename>, <filename class="directory">outbox</filename>, +<filename class="directory">sent-mail</filename>, <filename class="directory">trash</filename> and +<filename class="directory">drafts</filename>). Use <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure +&kmail;...</guimenuitem> </menuchoice> to enter some initial information +so &kmail; will be able to properly retrieve and send your +messages.</para> + +<para>The Configure window consists of six sections: +<guilabel>Identities</guilabel>, <guilabel>Network</guilabel>, +<guilabel>Appearance</guilabel>, <guilabel>Composer</guilabel>, +<guilabel>Security</guilabel>, and +<guilabel>Misc</guilabel>.</para> + +<para>To begin sending and receiving messages you will only have to +change some settings in the <guilabel>Identities</guilabel> and +<guilabel>Network</guilabel> pages.</para> + + <sect1 id="setting-your-identity"> + <title> + Setting your Identity + </title> + + <para> + The settings in the <guilabel>Identities</guilabel> page are + fairly straightforward. Select your default identity and click + <guibutton>Modify</guibutton>. Fill in the <guilabel>Your + name</guilabel> field with your full name (⪚ <userinput>John + Doe</userinput>) and the <guilabel>Organization</guilabel> field + (optional) with the appropriate information. + </para> + <para> + Next, fill in the <guilabel>Email address</guilabel> field with + your email address (⪚ <userinput>john@example.net</userinput>). + </para> + <para> + If you are using <application>PGP</application> or + <application>GnuPG</application> you can set your &openpgp; keys + and/or &smime; certificates in the <link + linkend="configure-identity-cryptography"><guilabel>Cryptography</guilabel></link> + tab. + </para> + <para> + Optionally, go to the <guilabel>Signature</guilabel> tab and + enter your signature. This is a short text that will be + automatically appended to all your messages. It has nothing to + do with <emphasis>digital signatures</emphasis>. + </para> + + </sect1> + +<sect1 id="setting-up-your-account"> +<title>Setting up your Account</title> + +<para>The <guilabel>Network</guilabel> page contains the settings that +tell &kmail; how to send and receive your email messages. Many of these settings +can vary greatly depending on the setup of your system and on the kind +of network that your mail server is located in. If you do not know what +setting to choose or what to put in a field, consult your Internet +Service Provider (<acronym>ISP</acronym>) or system +administrator.</para> + +<sect2 id="sending-mail"> +<title>Sending Messages</title> + +<para>The <guilabel>Sending</guilabel> tab provides a list of +ways to send messages. The first item in the list is the default +way to send messages. Using the <guibutton>Add...</guibutton> +button you can choose between two different ways of sending messages: +<guilabel>SMTP</guilabel> and +<guilabel>Sendmail</guilabel>. &Sendmail; here +means a local software installation -- this has a +reputation of being difficult to set up, so if you do not already have a +working &Sendmail; configuration, choose +<guilabel>SMTP</guilabel> and fill in the <guilabel>Name</guilabel> +field with a descriptive name +(⪚ <userinput>My Mail Account</userinput>) +and the <guilabel>Host</guilabel> +field with the name and domain of your mail server +(⪚ <userinput>smtp.provider.com</userinput>). You will probably +not need to change the <guilabel>Port</guilabel> setting (the default is +<userinput>25</userinput>).</para> + +<!-- TODO: more specific link --> +<para>If you do want to use &Sendmail; and you are using a dial-up +connection, follow the instructions for setting up sendmail for a +dial-up connection in the <link linkend="faq">&FAQ;</link> +section.</para> + +<para>The way of sending messages configured here will be used for +your default identity and for all other identities that have no own +way of sending messages. You can use different ways of sending +messages for different identities by selecting the <guilabel>Special +transport</guilabel> checkbox in the <guilabel>Advanced</guilabel> +tab of the <guilabel>Identities</guilabel> section.</para> + +<para>A description of the other options can be found +in the <link linkend="configure-accounts-sending">Configuration</link> +chapter.</para> + + +<sect3 id="sending-mail-kolab"> +<title>Options relevant to <acronym>Kolab</acronym> server</title> + +<para>When configuring a <guilabel>SMTP</guilabel> account with a <guilabel>Kolab</guilabel> server Host, you need to check the <guilabel>Server requires authentification</guilabel> option and to fill in your <guilabel>Kolab</guilabel> user's email address and password in the <guilabel>Login</guilabel> and <guilabel>Password</guilabel> fields. Select then the <guilabel>Security</guilabel> tab and click on the <guibutton>Check What the Server Supports</guibutton> for automated setup of your <guilabel>Security</guilabel> configuration. The default should be <guilabel>TLS/PLAIN</guilabel>. The <guilabel>Kolab</guilabel> server supports <guilabel>SSL/PLAIN</guilabel> as well. Those settings may of course be configured manually.</para> +</sect3> +</sect2> + +<sect2 id="receiving-mail"> +<title>Receiving Messages</title> + +<para>To set up an account so you can receive mail, press the +<guibutton>Add...</guibutton> button in the <guilabel>Receiving</guilabel> +tab. You will then be prompted for the type of your email account. Most users should +select <guilabel>POP3</guilabel> or <guilabel>IMAP</guilabel>. If +you want to use a local mailbox file, please see the <link linkend="faq-file-locking">FAQ +about file locking</link>.</para> + +<para>You will then be presented with +the <guilabel>Add account</guilabel> window. First, fill in the +<guilabel>Name</guilabel> field to name your account. You can choose any name +you like. <guilabel>Login</guilabel>, <guilabel>Password</guilabel>, and +<guilabel>Host</guilabel> should be filled in with the appropriate information +from your <acronym>ISP</acronym> or system administrator. You should not +need to change the <guilabel>Port</guilabel> setting (the default for POP3 is +<userinput>110</userinput>, the default for <acronym>IMAP</acronym> is +<userinput>143</userinput>).</para> + +<sect3 id="receiving-mail-kolab"> +<title>Options relevant to <acronym>Kolab</acronym> server</title> +<para> +select <guilabel>Disconnected IMAP</guilabel> when choosing your <guilabel>Account Type</guilabel>. Fill in the <guilabel>Login</guilabel> and <guilabel>Password</guilabel> fields with respectively your user email address and password on the <guilabel>Kolab</guilabel> server. In the <guilabel>Security</guilabel> section click on the <guilabel>Check What the Server Support</guilabel> button for automated set-up of your <guilabel>Security</guilabel> configuration. The default should be <guilabel>TLS/PLAIN</guilabel>. The <guilabel>Kolab</guilabel> server supports <guilabel>SSL/PLAIN</guilabel> as well. Those settings may of course be configured manually.</para> +<para> +If you want to use the <guilabel>"Out of Office" Replies</guilabel> functionality of the <guilabel>Kolab</guilabel> server, set-up the <guilabel>Filtering</guilabel> section of you <guilabel>DIMAP</guilabel> account by checking the <guilabel>Server supports Sieve</guilabel> option as well as <guilabel>Reuse host and login configuration</guilabel>, <guilabel>Managesieve port</guilabel> should be set to 2000 as default. +</para> +</sect3> + +<sect3 id="receiving-mail-dimap-misc"> +<title>Options only relevant to DIMAP (<acronym>Kolab</acronym> server)</title> +<para> +After having configured your <guilabel>Disconnect IMAP</guilabel> account, you +need to activate the <guilabel>Groupware</guilabel> functionalities and set-up +the <guilabel>Misc</guilabel> page for <guilabel>KMail</guilabel>. +</para> +<para> +In the <guilabel>Misc</guilabel> page, of the <guilabel>Configure</guilabel> dialog, choose the <guilabel>Groupware</guilabel> tab. Check the <guilabel>Enable IMAP resource functionality</guilabel> option and select <guilabel>Kolab (XML)</guilabel> as <guilabel>Format used for the groupware folders</guilabel>. The <guilabel>Resource folders are in account</guilabel> combo-box should be set on the <guilabel>Receiving</guilabel> (kolab user) account of your choice (if you happen to have several accounts).You may if you wish hide the groupware folder by checking this option. It is recommended to check both <guilabel>Groupware Compatibility and Legacy Options</guilabel> for compatibility with an eventual <guilabel>Kolab</guilabel> Microsoft Outlook client for sending invitations and replies from a <guilabel>Kolab</guilabel> KDE client. +</para> +</sect3> + +<sect3 id="receiving-mail-imap"> +<title>Options only relevant to <acronym>IMAP</acronym></title> +<para>If you are using <acronym>IMAP</acronym>, you can optionally +specify a path in the <guilabel>Prefix to folders</guilabel> field. This +tells &kmail; where it can find your folders on the server. If you also +have a shell account on the server and the messages are stored in your home +folder it might be useful to store the messages in a subfolder +<filename class="directory">Mail</filename>. Use this as a value in +the <guilabel>Prefix to folders</guilabel> field so that &kmail; does +not mix up mailbox files and other files. If you are not interested in +this feature, simple leave the field blank.</para> + +<para>If you check <guilabel>Automatically compact folders</guilabel> +&kmail; removes the messages you deleted from the +server as soon as you leave a folder. Otherwise the messages are +only marked as deleted and it is up to you to compact the folders +manually by using the menu item <menuchoice><guimenu>File</guimenu><guimenuitem>Compact All +Folders</guimenuitem></menuchoice>.</para> +<para>If you check <guilabel>Show hidden folders</guilabel>, +folders whose name starts with a dot are also displayed.</para> +</sect3> + + +<sect3 id="receiving-mail-pop3"> +<title>Options only relevant to POP3</title> + +<para>Select <guilabel>Leave fetched messages on the server</guilabel> if you want to +leave your messages on the server after you downloaded them.</para> + +<para>Select <guilabel>Exclude from "Check Mail"</guilabel> if you +do not want to check this account whenever you use <menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>. You can still check for new messages on this account +with <menuchoice><guimenu>File</guimenu><guimenuitem>Check Mail +In</guimenuitem></menuchoice>.</para> + +<para>Select <guilabel>Enable interval mail checking</guilabel> if you want +&kmail; to check for new messages automatically. The interval can be specified below +under <guilabel>Check interval</guilabel>.</para> + +<para><guilabel>inbox</guilabel> is the default folder for incoming +messages. If you want to change that for some reason, you can do so with +<guilabel>Destination folder</guilabel>. But what you probably want is a +<link linkend="filters">filter</link>, which has nothing to do with this +option.</para> + +<para>With <guilabel>Precommand</guilabel> you can specify any program that &kmail; +will execute just before fetching mail. Please specify the full path +(do not use <quote>~</quote>) and note that &kmail; will not continue +until the program returns.</para> + +<para>On the <guilabel>Extras</guilabel> tab you can select <guilabel>Use +pipelining for faster mail download</guilabel> if this is supported by your +server. You should carefully test this to make sure it works safely.</para> +</sect3> + +<sect3 id="receiving-mail-imap-pop3"> +<title>Options for both <acronym>IMAP</acronym> and POP3</title> + +<!-- TODO: move all this, this isn't important for beginners?! --> +<para>If you select <guilabel>Store POP password in configuration +file</guilabel> or <guilabel>Store IMAP password in configuration +file</guilabel> &kmail; will remember your password so you will not have to +type it every time you start &kmail; and fetch new mail.</para> + +<warning><para>Be warned that &kmail; cannot really encrypt your password, so +people who can access your configuration files (⪚ system +administrators) can easily get your password if you select this +option.</para></warning> + +<para>&kmail; supports encryption via <guilabel>SSL</guilabel> and +<guilabel>TLS</guilabel> (<guilabel>TLS</guilabel> should be preferred +if it is available).</para> + +<para>For POP3 &kmail; supports:</para> + +<itemizedlist> +<listitem><para><guilabel>Clear text</guilabel>, </para></listitem> +<listitem><para><guilabel>PLAIN</guilabel>, </para></listitem> +<listitem><para><guilabel>LOGIN</guilabel>, </para></listitem> +<listitem><para><guilabel>CRAM-MD5</guilabel> (recommended +if <guilabel>DIGEST-MD5</guilabel> is not available),</para></listitem> +<listitem><para><guilabel>DIGEST-MD5</guilabel> (recommended) and</para></listitem> +<listitem><para><guilabel>APOP</guilabel> authentication.</para></listitem> +</itemizedlist> + +<para><guilabel>DIGEST-MD5</guilabel>, <guilabel>CRAM-MD5</guilabel> and +<guilabel>APOP</guilabel> are secure on their own, the other +options are only secure when used together with <guilabel>SSL</guilabel> +or <guilabel>TLS</guilabel>. You should only use <guilabel>Clear +text</guilabel> if your server does not support any of the other +authentication methods. Additionally, for <acronym>IMAP</acronym> +<guilabel>Anonymous</guilabel> is supported, but <guilabel>APOP</guilabel> +is not. Use the <guibutton>Check what the server supports</guibutton> button +on the <guilabel>Extras</guilabel> or <guilabel>Security</guilabel> tab +to automatically select the most secure settings supported by your server.</para> + +<para>You are now ready to send and receive mail. For +<acronym>IMAP</acronym>, just open your folders in the +folder tree in &kmail;'s main window. &kmail; then connects to your +server and displays the messages it finds. For POP3 use +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>.</para> + +</sect3> + +</sect2> + +</sect1> + +<sect1 id="testing-your-setup"> +<title>Testing your Setup</title> + +<para>First, you should send yourself a message to test your +configuration. To send a message, either hit <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo>, select the +<guiicon>New Message</guiicon> icon or select +the <menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message...</guimenuitem></menuchoice> menu item. The +<link linkend="the-composer-window">composer window</link> will appear. Fill in the +<guilabel>To:</guilabel> field with your email address and type +something in the <guilabel>Subject</guilabel> field. Send the message by +selecting <menuchoice><guimenu>Message</guimenu> <guimenuitem>Send</guimenuitem> +</menuchoice>.</para> + +<para>To check your email, select +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>. In the lower right corner of the main +window, a progress bar will indicate how many messages are being +downloaded. If you receive the message you just sent, then +congratulations! If, however, you receive any error messages while +testing your setup, make sure that your network connection is working +and recheck your settings at +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice>.</para> + +</sect1> + +</chapter> diff --git a/doc/kmail/importing.docbook b/doc/kmail/importing.docbook new file mode 100644 index 000000000..6cc909631 --- /dev/null +++ b/doc/kmail/importing.docbook @@ -0,0 +1,270 @@ +<chapter id="importing"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2002-10-03</date> +<releaseinfo>1.5</releaseinfo> +</chapterinfo> + +<title>Using other Mailbox Files with &kmail;</title> + +<para>&kmail; offers an import tool for the messages and address books of some +other email clients. You can access it using <menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Import...</guimenuitem></menuchoice>. Please make sure that you +compact your folders in the other email client, no matter if you are going to use +the import utility or if you are going to copy files manually. +You only need to read this chapter if this tool does not work for you.</para> + +<para>This section is for all of the users who need to move email messages +from their previous email client over to &kmail;. &kmail; can store its +messages using <quote>mbox</quote> or <quote>maildir</quote> formats, which +are the most widely-used mailbox formats on &UNIX; systems. Mbox mailboxes +store messages in one file, identifying where messages start and end with a +<literal>From</literal> line (do not mix this up with the +<literal>From:</literal> header that contains the message's sender); +Maildir uses one file per message. For many &UNIX; email clients, all you +must do is move your mailboxes to <filename +class="directory">~/Mail</filename> (or make <filename +class="symlink">Mail</filename> a symbolic link to the folder containing +your mailboxes), make sure they are writable by your user, and launch +&kmail;. The mailboxes should now show up correctly in &kmail;.</para> + +<para>Please have a look at the +<ulink url="http://kmail.kde.org/tools.html">Tools section of &kmail;'s +homepage</ulink> first, to see if there is a tool that imports your mailbox +and maybe even address book.</para> + +<warning><para>Do not use a second email client that accesses the files in +<filename class="directory">~/Mail</filename> while &kmail; is running or +you might lose messages. This section only explains how to import mailboxes +to &kmail; once; it is not useful to you if you're planning to use several +email clients for your mailboxes in the future.</para></warning> + +<variablelist> + +<varlistentry> +<term><application>Eudora Lite</application>/<application>Eudora +Pro</application></term> +<listitem> +<para><application>Eudora</application> uses the mbox format in its mail +files. To use them with &kmail;, make sure that your +<application>Eudora</application> mailboxes have been compacted, then copy the +<literal role="extension">.mbx</literal> files (&Windows; +<application>Eudora</application>) or <application>Eudora</application> mailbox +files (&Mac; <application>Eudora</application>) to your <filename +class="directory">~/Mail</filename> folder. You do not need to copy the +<filename>index</filename> files. Once you start &kmail;, the mailboxes should +appear in the Folders pane and the messages should be accessible in the Headers +pane.</para> +<para>If messages do not appear in the Headers pane, your mailbox files may +still contain &Windows; or &Mac; line-feed characters. Use your favorite +text editor, the <application>recode</application> command or a scripting +language to change the &Windows; or &Mac; line feeds to &UNIX; line +feeds.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><application>Mailsmith</application></term> +<listitem> +<para><application>Mailsmith</application> runs on &Mac; and uses its own database +format; however it is possible to export mail into mbox format using +<menuchoice><guimenu>File</guimenu><guimenuitem>Export +Mail</guimenuitem></menuchoice> on a +selected mailbox or on selected messages. Once the messages have been exported, translate +the &Mac; line breaks to &UNIX; line breaks using your favorite editor, or using the following +command under &Linux;:</para> + +<para><userinput><command>cat</command> <option>mail-mac.txt</option> +| perl -e 'while (<STDIN>) { s/\r/\n/gi; print $_ ;}' > mail-unix.txt</userinput></para> + +<para>&kmail; will only recognize mboxes placed directly in the <filename class="directory">~/Mail/</filename> +folder. This means that a folder hierarchy cannot be preserved by simply moving files into the +<filename class="directory">~/Mail/</filename> folder, but will need to be reconstructed +within &kmail; manually.</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term>MMDF</term> +<listitem> +<para>This format is close enough to the mailbox format that &kmail; should be +able to use these mailboxes if you just copy them to your +<filename class="directory">~/Mail</filename> folder; however, MMDF mailboxes +have not been tested with &kmail;, so your results may vary. If you can get +this format to work with &kmail;, please let us know so we can include more +specific directions in the next documentation release.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>MH mailboxes</term> +<listitem> +<para>MH mailboxes are directories containing files that correspond to each +message in that mailbox. A shell script to convert MH mailboxes to mbox +mailboxes, <command>mh2kmail</command>, is included at least in the source +releases of &kmail;, but maybe not in the packaged releases. Running this script +on a MH folder will convert it to an mbox file. We strongly suggest that you +back up your MH mail folders before you use this script.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Forte <application>Agent</application></term> +<listitem> +<para>In <application>Agent</application>:</para> +<procedure> +<step> +<para>Select the messages to export</para> +</step> +<step> +<para>Select <menuchoice><guimenu>FILE</guimenu><guimenuitem>SAVE MESSAGES +AS</guimenuitem></menuchoice></para> +</step> +<step> +<para>Mark the <guilabel>UNIX FORMAT</guilabel> and <guilabel>SAVE +RAW</guilabel> boxes</para> +</step> +<step> +<para>Give File a <literal role="extension">.txt</literal> extension and +save.</para> +</step> +</procedure> + +<para>In &kde;:</para> + +<procedure> +<step> +<para>Move the previously-saved file to the correct <filename +class="directory">~/Mail</filename> folder</para> +</step> +<step> +<para>Rename file without <literal role="extension">.txt</literal> +extension</para> +</step> +</procedure> +<para>When you open &kmail; the new folder with appropriate messages will be +there.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>&Netscape; Mail</term> +<listitem> + +<para>If you are using &Netscape; 4.x, the mail files should be found +in <filename class="directory">~/nsmail</filename>; if you are using +&Netscape; 6.x, they're buried in a folder deep in the <filename +class="directory">~/.mozilla</filename> subfolder, something like: +<filename +class="directory">/home/user_name/.mozilla/user_name/2ts1ixha.slt/Mail/Mail/server_name</filename> +(the <filename class="directory">2ts1ixha.slt</filename> string will +probably vary, so check it on your own system.) The <filename +class="directory">[...]/Mail/Mail</filename> folder contains one +subfolder for each account from which you receive mail through +Netscape (⪚ <filename +class="directory">[...]/Mail/Mail/math.university.edu</filename>); +you will need to copy files from each of them if you want everything to +be accessible under &kmail;.</para> + +<para>If you have no subfolders, just copy all of the &Netscape; +files to <filename class="directory">~/Mail</filename>, make sure +that they are writable (only by your user, of course), and restart +&kmail;: all of the messages will now appear in &kmail; folders. +(Note that if you use a command like <command>cp +<parameter>*</parameter> <parameter>~/Mail</parameter></command>, you +should follow it with <command>rm <option>-f</option> +<parameter>~/Mail/*.msf</parameter></command>; every &Netscape; 6 +folder has a corresponding <filename>.msf</filename> file, and if you +do not get rid of them you will have a bunch of spurious empty +folders.)</para> + +<para>If you were using subfolders under &Netscape; (⪚ a main +folder called <replaceable>Work</replaceable> with subfolders called +<replaceable>Jim</replaceable> and <replaceable>Nancy</replaceable>), +there are additional steps required. First, create the main folder +(<replaceable>Work</replaceable>) in &kmail; and create a temporary +child folder under it (by right-clicking on the folder name and +selecting <guilabel>Create child folder</guilabel>); it does not +matter what you call this folder -- <replaceable>dummy</replaceable> +or the default <replaceable>unnamed</replaceable>, for example. Once +a child folder has been requested, &kmail; creates a hidden folder +in <filename class="directory">~/Mail</filename> called (in this +example) <filename class="directory">.Work.directory</filename>. You +can then copy your &Netscape; subfolder files +(<replaceable>Jim</replaceable> and <replaceable>Nancy</replaceable>) +into <filename class="directory">~/Mail/.Work.directory</filename>, +and restart &kmail;; the child folders will appear under the main +folder <replaceable>Work</replaceable>. Of course, this procedure may +be extended for sub-subfolders, to any depth. (You can remove the +temporary child folders afterwards, unless it amuses you to have a +<replaceable>Work</replaceable> subfolder called +<replaceable>dummy</replaceable>.)</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><application>Pegasus Mail</application></term> +<listitem> +<para><application>Pegasus</application> for win32 uses single files for Mail +folders similar to &kmail;. <application>Pegasus mail</application> folder files +have the extension <literal role="extension">.pmm</literal> but they are the same format as mbox except the messages +do not start with the <literal>From</literal> header, but with a control character. To work around +this, replace each instance of the control character with <literal>From +aaa@aaa Mon Jan 01 00:00:00 1997</literal>. This <literal>From</literal> +line should be the first line of every message, before the +<literal>Received:</literal> and other headers. Make sure to use a text editor +that lets you save the files in &UNIX; format or create new folders in +<application>Pegasus</application> that are in &UNIX; format and copy your messages +there.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Maildir / Outlook Express / xfmail</term> +<listitem> +<para>Tools to convert these formats are available at the +<ulink url="http://kmail.kde.org/tools.html">Tools section of &kmail;'s +homepage</ulink>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Lotus <application>Notes</application>, BeOS Mail files, <application>cc: +Mail</application>, &etc;...</term> +<listitem> +<para>First you should have a look at <ulink +url="http://kmail.kde.org/tools.html">Tools section of &kmail;'s homepage</ulink> if +there are tools to convert your messages.</para> +<para>Mail programs not listed here or on the homepage probably do not work with &kmail; as they use +proprietary mail formats that &kmail; cannot understand. However, there is no +harm in trying! If the mailbox file looks similar to the mbox format, try +copying the mailbox file (remember, the index file is not needed) to your +<filename class="directory">~/Mail</filename> folder and see what happens if you start +&kmail;. If you get mailboxes from your favorite email client to work in &kmail;, +please tell us how you did it so that we can include directions in a future +revision of this documentation. </para> +</listitem> +</varlistentry> + +</variablelist> + +</chapter> diff --git a/doc/kmail/index.docbook b/doc/kmail/index.docbook new file mode 100644 index 000000000..fe38a5100 --- /dev/null +++ b/doc/kmail/index.docbook @@ -0,0 +1,161 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kmail;"> + <!ENTITY package "kdepim"> + <!ENTITY kmail-intro SYSTEM "intro.docbook"> + <!ENTITY kmail-getting-started SYSTEM "getting-started.docbook"> + <!ENTITY kmail-using-kmail SYSTEM "using-kmail.docbook"> + <!ENTITY kmail-configure SYSTEM "configure.docbook"> + <!ENTITY kmail-menus SYSTEM "menus.docbook"> + <!ENTITY kmail-faq SYSTEM "faq.docbook"> + <!ENTITY kmail-importing SYSTEM "importing.docbook"> + <!ENTITY kmail-credits-and-licenses SYSTEM "credits-and-licenses.docbook"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY html "<acronym>HTML</acronym>"> + <!ENTITY gpg "<application>GPG</application>"> + <!ENTITY gpgsm "<application>GpgSM</application>"> + <!ENTITY mdn "<acronym>MDN</acronym>"> + <!ENTITY acl "<acronym>ACL</acronym>"> + <!ENTITY imap "<acronym>IMAP</acronym>"> + <!ENTITY nntp "<acronym>NNTP</acronym>"> + <!ENTITY openpgp "<acronym>OpenPGP</acronym>"> + <!ENTITY smime "<acronym>S/MIME</acronym>"> + <!ENTITY kolab "<acronym>Kolab</acronym>"> +]> +<book lang="&language;"> +<bookinfo> +<title>The &kmail; Handbook</title> + + <!-- Note: +* please do not mix up the formatting more than necessary so that + "cvs diff" makes useful output +* no short forms +* use <warning> instead of <caution> +--> + +<!-- TODO: +*index (see kdegames/kpat/) + +* guisubmenu vs. guititem ?? +* more about security? + +* Configure KMail: "page" or "tab", but no mix of both! +* add section for drag'n'drop? +* "Using other mailbox..." -> sounds strange? + +* use better markup instead of 'quote'? +* fix my adverb vs. adjective mistakes + +* coherent wording for section / tab / ... +* <menuchoice><guimenu>xxx , or is <guimenu>xxx enough? +* <guiicon> vs. <guibutton> +* spelling: popup vs pop up, frontend vs front end + +* message vs. mail vs. email -> using "message" everywhere +* window vs. dialog: a dialog is modal, a window is not (I think) + +* in KMail: kmail vs. KMail +--> + +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> + +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2004-07-13</date> +<releaseinfo>1.7</releaseinfo> + +<copyright> +<year>1999</year> +<year>2000</year> +<year>2001</year> +<year>2002</year> +<holder>David Rugge</holder> +</copyright> +<copyright> +<year>2003</year> +<holder>Daniel Naber</holder> +</copyright> +<copyright> +<year>2004</year> +<holder>Daniel Naber</holder> +<holder>Ingo Klöcker</holder> +</copyright> + +<abstract> + +<para>&kmail; is &kde;'s powerful and user friendly email client.</para> + +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Mail</keyword> +<keyword>email</keyword> +<keyword>Client</keyword> +<keyword>POP3</keyword> +<keyword>IMAP</keyword> +<keyword>PGP</keyword> +<keyword>GnuPG</keyword> +<keyword>GPG</keyword> +<keyword>Kolab</keyword> +</keywordset> +</bookinfo> + +&kmail-intro; +&kmail-getting-started; +&kmail-using-kmail; +&kmail-configure; +&kmail-menus; +&kmail-faq; +&kmail-importing; +&kmail-credits-and-licenses; + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kmail"> +<title>How to obtain &kmail;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +</appendix> +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=0:sw=2:tw=78:noet +--> diff --git a/doc/kmail/intro.docbook b/doc/kmail/intro.docbook new file mode 100644 index 000000000..29d7173af --- /dev/null +++ b/doc/kmail/intro.docbook @@ -0,0 +1,56 @@ +<chapter id="intro"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-13</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Introduction</title> + +<para>The &kmail; Team welcomes you to &kmail;, a user-friendly email client for the +K Desktop Environment. Our goal is to make &kmail; a program that is beautiful +and intuitive without sacrificing power. </para> + +<para>If you have never set up an email client on a &UNIX; system +before, we suggest that you read through the <link +linkend="getting-started">Getting Started</link> section first so that +your setup goes smoothly.</para> + +<para>Since most people do not read documentation anyway, here is a +collection of the most helpful tips:</para> + +<itemizedlist> +<listitem> +<para>You do not have to use your mouse to use &kmail;. Everything can +be done by using <link linkend="keyboard-shortcuts">Keyboard Shortcuts</link>.</para> +</listitem> +<listitem> +<para>Although &kmail; can be considered reliable you should keep +backups of your messages, &ie; just copy the files and folders +in <filename class="directory">~/Mail</filename> +(including the hidden ones that start with a dot) to a safe place.</para> +</listitem> +<!-- TODO: add other tips for "invisible" features here --> + +</itemizedlist> + +<para>&kmail;'s homepage can be found at <ulink +url="http://kmail.kde.org">http://kmail.kde.org</ulink>. There you will +find useful links, ⪚ to the user and developer mailing lists. +Please report bugs in &kmail; using +<menuchoice><guimenu>Help</guimenu><guimenuitem>Report +Bug...</guimenuitem></menuchoice>.</para> + +<para>We hope you will enjoy &kmail;!</para> + +</chapter> diff --git a/doc/kmail/menus.docbook b/doc/kmail/menus.docbook new file mode 100644 index 000000000..ff281f053 --- /dev/null +++ b/doc/kmail/menus.docbook @@ -0,0 +1,2222 @@ +<chapter id="menus"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<author> +<firstname>David</firstname> +<surname>Rugge</surname> +<affiliation><address> +<email>davidrugge@mediaone.net</email> +</address></affiliation> +</author> +<author> +<firstname>Michel</firstname> +<surname>Boyer de la Giroday</surname> +<affiliation><address> +<email>michel@klaralvdalens-datakonsult.se</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-07-11</date> +<releaseinfo>1.7</releaseinfo> +</chapterinfo> + +<title>Menu Entries</title> + +<para>Each menu item is discussed below. When there is a keyboard shortcut that +performs a menu item function, the default shortcut is listed with the menu item.</para> + +<sect1 id="main-mail-reader-window"> +<title>The Main Window</title> + +<sect2 id="reader-file-menu"> +<title><guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>New Window</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Creates a new main window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Allows you to open files which contain email messages.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save As...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Saves the currently displayed message to a text file, including all the headers +and attachments.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Display a dialog that lets you prints the currently displayed message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Compact All Folders</guimenuitem> +</menuchoice></term> +<listitem> +<para>Will compact all folders, &ie; it will really move and delete the messages +on disk according to how you have moved and deleted them in &kmail;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Expire All Folders</guimenuitem> +</menuchoice></term> +<listitem> +<para>Delete old messages from all folders, according to the rules in +each folder's <link linkend="folders-properties-window">Properties dialog</link> +(the default is not to delete old messages at all).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Refresh Local &imap; Cache</guimenuitem> +</menuchoice></term> +<listitem> +<para>This will remove all changes that you have done locally to your IMAP +folders and redownload everything from the server. Use this if the local +cache was corrupted.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Empty All Trash Folders</guimenuitem> +</menuchoice></term> +<listitem> +<para>Use this to empty all trash folders, &ie; the local trash folder and +all trash folders that you might have on &imap; servers.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Check Mail</guimenuitem> +</menuchoice> +</term> +<listitem><para>Checks for new messages in all your accounts, except those that +have <guilabel>Exclude from "Check Mail"</guilabel> enabled.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Check Mail In</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Submenu that lets you check for new messages from a particular account.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Send Queued Messages</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sends the messages that are in your outbox.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Closes the current main window or exits +&kmail; if there is only this one window.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="reader-edit-menu"> +<title><guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Revokes your last move or delete action. Note that you cannot undo a deletion +in the trash.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Copies selected text to the clipboard.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>T</keycap></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Edit Message</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Edits the selected message if it is editable. Only messages in the +<guilabel>outbox</guilabel> and <guilabel>drafts</guilabel> folder can be edited.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>Delete</keycap></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Move to Trash</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Moves the selected messages to the trash folder. If the selected +messages are already in the trash folder, they will really be deleted.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>Delete</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Delete</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Deletes the selected messages. There is no way to recover the messages +once they are deleted with this command.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find in Message...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Lets you search for a string in the currently displayed message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All Messages</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects all messages in the current folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select Message Text</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects the text of the currently displayed message.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="reader-view-menu"> +<title><guimenu>View</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Headers</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Changes the format of the message header in the <guilabel>Message pane</guilabel>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Attachments</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Changes the way attachments appear in the <guilabel>Message +pane</guilabel> (independent of the MIME Tree). With <guimenuitem>As Icons</guimenuitem> +all attachments appear as icons at the bottom of the message. +<guimenuitem>Smart</guimenuitem> will show attachments as +icons, unless the message suggests that they should be displayed inline. +You can suggest that certain attachments should be shown inline +in your own messages when you select <guilabel>Suggest automatic display</guilabel> +in the attachment's properties dialog. +<guimenuitem>Inline</guimenuitem> shows the contents of the attachments +at the bottom of the message. Attachments that cannot be displayed, ⪚ +compressed files, will still be shown as an icon. +<guimenuitem>Hide</guimenuitem> will not show attachments. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Unread Column</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Allows you to specify whether the number of unread messages should +be shown in parentheses next to the folder name (<guilabel>View After Folder +Name</guilabel>) or in a separate column (<guilabel>View in Separate +Column</guilabel>)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Total Column</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Display a column in the list of folders which shows the number +of messages per folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>.</keycap></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Expand Thread</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If <menuchoice><guimenu>Folder</guimenu><guimenuitem>Thread Messages</guimenuitem> +</menuchoice> is activated, this will display the thread of the current message, &ie; +all messages that are replies to the current message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>,</keycap></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Collapse Thread</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If <menuchoice><guimenu>Folder</guimenu><guimenuitem>Thread Messages</guimenuitem> +</menuchoice> is activated, this will hide the thread of the current message, &ie; +it will hide all messages that are replies to the current message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>.</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Expand All Threads</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Expands all threads in the current folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>,</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Collapse All Threads</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Collapses all threads in the current folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>V</keycap></shortcut> +<guimenu>View</guimenu> +<guimenuitem>View Source</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the message and its complete headers in plain text format in a new +window. This can be useful to find out the origin of a mail. You should know +that it is easy to fake the <literal>From:</literal> header of a mail, but +one can still find out which mail servers have been used to send the message by looking +at the <literal>Received:</literal> lines in the header.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>X</keycap></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Use Fixed Font</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Uses a fixed width (monospaced) font to display the messages +in the current folder. The font to be used can be configured in the +<guilabel>Appearance</guilabel> section of &kmail;'s configuration +dialog.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Set Encoding</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Lets you choose the character encoding to be used in the Message +Pane. The default, <guilabel>Auto</guilabel>, should work in almost all cases.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="reader-go-menu"> +<title><guimenu>Go</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>N</keycap></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Next Message</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects the next message in the message list. The keyboard shortcut +<keycap>Right Arrow</keycap> also performs this action.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>+</keycap></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Next Unread Message</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects the next unread message in the message list. If there is +no unread message below the currently selected message then the behavior +depends on the value of the <xref +linkend="configure-misc-folders-go-unread"/> option.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>P</keycap></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Previous Message</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects the previous message in the message list.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>-</keycap></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Previous Unread Message</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects the previous unread message in the message list. If there is +no unread message above the currently selected message then the behavior +depends on the value of the <xref +linkend="configure-misc-folders-go-unread"/> option.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Next Unread Folder</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Jumps to the the next folder with unread messages.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Previous Unread Folder</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Jumps to the the previous folder with unread messages.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>Space</keycap></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Next Unread Text</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Scrolls down if you are not yet at the bottom of a message, otherwise +jumps to the next unread message.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="reader-folder-menu"> +<title><guimenu>Folder</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>New Folder...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the <link linkend="folders-properties-window">Folder Properties</link> +dialog that lets you create a new folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Mark All Messages as Read</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Sets the status of all new and unread messages in the current folder to read.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Compact</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Compacts the folder file to reduce its disk space usage. Usually +&kmail; compacts all folders automatically, but under certain circumstances +you might want to compact a folder manually.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Expire</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Deletes old messages from the current folder or moves them to another +folder, according to the rules in the folder's <guilabel>Properties</guilabel> dialog (the default is not to delete or move old messages). Usually &kmail; +does this automatically, but under certain circumstances you might want to +expire a folder manually..</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>*</keycap></keycombo></shortcut> +<guimenu>Folder</guimenu> +<guimenuitem>Remove Duplicate Messages</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Searches the folder for duplicate messages and deletes the +duplicates.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>F5</keycap></shortcut> +<guimenu>Folder</guimenu> +<guimenuitem>Check Mail in This Folder</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Checks whether new mail arrived in the currently selected folder. +This is only available for &imap; folders.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Troubleshoot IMAP Cache...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a dialog that helps to solve problems with synchronizing disconnected &imap; folders. +</para> +<para><guilabel>Rebuild Index</guilabel>. As a first step to solve synchronization problems, you can rebuild the index file. This will take some time, but can not cause any problems or data loss. +You can select if the indexes should be rebuilt for the selected folder only (<guilabel>Only current folder</guilabel>), the selected folder and its folder subtree (<guilabel>Current folder and all subfolders</guilabel>), or for the whole account (<guilabel>All folders of this account</guilabel>). +</para> +<para> +<guilabel>Refresh Cache</guilabel>: +If rebuilding the index does not solve the problem, you can refresh the local IMAP cache for the current folder and all subfolders. The cache is deleted and the mails are refetched from the server. This will delete all your local changes in these folders! +</para> +<para> +This option is only available for disconnected &imap; folders. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Move All Messages to Trash</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Moves all of the messages in the selected folder into the trash folder. +This is only available if the currently selected folder is not a trash +folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Empty Trash</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Permanently deletes all messages. This is only available if the +currently selected folder is a trash folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Delete Folder</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Removes the selected folder and all its contents, including subfolders.</para> +<warning><para>Note that there is no way to access the contents +of a folder after it has been removed.</para></warning> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Prefer HTML to Plain Text</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled then &html; messages in this folders will be shown using +&html; rendering. For security reasons, we recommend to only +activate this for folders which only contain trusted messages.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Thread Messages</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled then the messages in the message list +are shown in a tree-like list, with replies showing up directly under the +message they reply to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Thread Messages also by Subject</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled then the messages are not only grouped according to special +information included in the messages but also according to their subject, +&ie; messages with the same subject are considered as being related. +If many messages are threaded below unrelated messages then you might want +to disable this option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Folder</guimenu> +<guimenuitem>Properties</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up the <link linkend="folders-properties-window">Properties dialog</link> which lets you +change the settings for the selected folder.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="reader-message-menu"> +<title><guimenu>Message</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>New Message...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the <link linkend="the-composer-window">composer window</link> so you can +write a new message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>New Message to Mailing-List...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the composer window so you can write a new +mail. If the current folder holds a mailing list and has a posting +address defined, this address will be the default <guilabel>To:</guilabel> +address.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>R</keycap></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Reply...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up the composer window, inserts the quoted text of the currently +selected message and presets the <guilabel>To:</guilabel> field either with +the mailing-list address (if you reply to a mailing-list message) or with the +preferred reply address of the sender. If you want to control which address +the <guilabel>To:</guilabel> field is preset with then you should either use +<menuchoice><guimenu>Message</guimenu><guimenuitem>Reply to +Author...</guimenuitem></menuchoice> or +<menuchoice><guimenu>Message</guimenu><guimenuitem>Reply to +Mailing-List...</guimenuitem></menuchoice>. +Your identity will automatically be set to the one which this message was +sent to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>A</keycap></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Reply to All...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up the composer window, inserts the quoted text of the currently +selected message and presets the <guilabel>To:</guilabel> field either with +the mailing-list address (if you reply to a mailing-list message) or with the +preferred reply address of the sender. The <guilabel>Copy to (CC):</guilabel> +field is preset with the addresses of all other recipients of the currently +selected message excluding your own addresses. +Your identity will automatically be set to the one which this message was +sent to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Reply to Author...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up the composer window, inserts the quoted text of the currently +selected message and presets the <guilabel>To:</guilabel> field with the +preferred reply address of the sender. +Your identity will automatically be set to the one which this message was +sent to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>L</keycap></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Reply to Mailing-List...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up the composer window, inserts the quoted text of the currently +selected message and presets the <guilabel>To:</guilabel> field with +the mailing-list address. If you did not specify a mailing-list address for +the currently selected folder and &kmail; cannot determine the posting address +from the currently selected message then the <guilabel>To:</guilabel> field +will be empty. +Your identity will automatically be set to the one which this message was +sent to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Reply Without Quote...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Works just like <guimenuitem>Reply...</guimenuitem> except that the text +of the currently selected message is not quoted.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>Forward</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Forwards the message to a new recipient. +Using <guimenuitem>As Attachment</guimenuitem> the message and its attachments +will become an attachment of the new message. The original message headers will +be included in the forwarded message, too. + +Using <guimenuitem>Inline</guimenuitem>, the message's text and some important +header fields will be copied to the body of the new message with a text marking +the forwarded part. Attachments will be forwarded as attachments of the new +message. + +<guimenuitem>As Digest</guimenuitem> concatenates the messages together as a +MIME digest attachment. + +<guimenuitem>Redirect</guimenuitem> works like forward, except that the message +stays the same (even the <guilabel>From:</guilabel> field). The user who +redirected the message is added in special header fields (<literal>Redirect-From</literal>, +<literal>Redirect-Date</literal>, <literal>Redirect-To</literal>, &etc;). +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>Send Again...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a composer window with the currently selected message so it can be +sent again. This is only available for messages which you have sent or, more +precisely, for messages which have the <guilabel>sent</guilabel> status.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Copy To</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Copies the selected messages to a certain folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Move To</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Moves the selected messages to a certain folder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Mark Message</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Allows you to change the status of the selected message to one of the +following states:</para> +<!-- TODO: I think it is worth adding inline images here, at some point. LW. --> +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Status</entry> +<entry>Symbol</entry> +<entry>Meaning</entry> +</row> +</thead> +<tbody> +<row> +<entry><guimenuitem>Read</guimenuitem></entry> +<entry>Sheet of paper before an envelope</entry> +<entry>The message has been read.</entry> +</row> +<row> +<entry><guimenuitem>New</guimenuitem></entry> +<entry>Closed envelope with a star</entry> +<entry>The message is new to &kmail; and you.</entry> +</row> +<row> +<entry><guimenuitem>Unread</guimenuitem></entry> +<entry>Close envelope</entry> +<entry>The message is not new to &kmail; but has not been read yet.</entry> +</row> +<row> +<entry><guimenuitem>Important</guimenuitem></entry> +<entry>Flag</entry> +<entry>This status will not automatically be set by &kmail;. You can use it freely to mark +messages that are in some way important to you.</entry> +</row> +<row> +<entry><guimenuitem>Replied</guimenuitem></entry> +<entry>Blue u-turn arrow</entry> +<entry>A reply to this message has been sent.</entry> +</row> +<row> +<entry><guimenuitem>Forwarded</guimenuitem></entry> +<entry>Blue arrow</entry> +<entry>The message has been forwarded to someone else.</entry> +</row> +<row> +<entry><guimenuitem>Queued</guimenuitem></entry> +<entry>Envelope</entry> +<entry>The message has been queued in the outbox to be sent later.</entry> +</row> +<row> +<entry><guimenuitem>Sent</guimenuitem></entry> +<entry>Angled envelope</entry> +<entry>The message has been sent.</entry> +</row> +<row> +<entry><guimenuitem>Spam</guimenuitem></entry> +<entry>Round recycle symbol</entry> +<entry>This status will not be set automatically by &kmail;. You can use it +to mark spam messages.</entry> +</row> +<row> +<entry><guimenuitem>Ham</guimenuitem></entry> +<entry>Green check mark</entry> +<entry>This status will not be set automatically by &kmail;. You can use it +to mark messages which are not spam.</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Mark Thread</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Allows you to change the status of all messages in a thread. The possible +states are the same as for <menuchoice><guimenu>Message</guimenu> +<guimenuitem>Mark Message</guimenuitem></menuchoice>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Watch Thread</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Use this to mark threads which you want to keep an eye on for further +contributions to the discussion.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Ignore Thread</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Use this to mark threads you are not interested in. New contributions +to this thread will automatically be marked as read.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guisubmenu>Create Filter</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Opens up the <link linkend="filter-dialog-id">Filter dialog</link> with a new filter added. +This new filter is based on fields of the current mail, depending on which +sub menu item you select.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Apply Filters</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Applies your filters to the selected messages.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>Apply Filter</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Allows you to apply an individual filter to the selected messages. Only +filters for which you enabled the <guilabel>Add this filter to the Apply +Filter menu</guilabel> option will be available.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="reader-tools-menu"> +<title><guimenu>Tools</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>S</keycap></shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Find Messages...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up a search window that lets you search for messages with +certain characteristics, ⪚ a certain subject. Start the search by entering +some values and press <guibutton>Search</guibutton>. Click on one of the +resulting messages and it will appear in the <guilabel>Message +pane</guilabel>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Address Book</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Starts up <ulink url="/kaddressbook/">&kaddressbook;</ulink>, +the &kde; address book.</para> +</listitem> +</varlistentry> + + <varlistentry id="reader-tools-certificate-manager"> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Certificate Manager...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Starts <ulink + url="/kleopatra"><application>Kleopatra</application></ulink>, + the &kde; certificate manager. + </para> + </listitem> + </varlistentry> + + <varlistentry id="reader-tools-gnupg-log-viewer"> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>GnuPG Log Viewer</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Starts <ulink + url="/kwatchgnupg"><application>KWatchGnuPG</application></ulink>, + a tool to present the debug output of + <application>GnuPG</application> application. If + signing, encryption, or verification mysteriously stop + working, you might find out why by looking at the log. + </para> + </listitem> + </varlistentry> + + <varlistentry id="reader-tools-import-messages"> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Import Messages...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Starts up <application>kmailcvt</application> (which is + part of kdepim). This application lets you import + messages from several email clients &kmail;. + </para> + </listitem> + </varlistentry> +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guisubmenu>Edit "Out of Office" Replies...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Launch the <guilabel>Configure "Out of Office" Replies</guilabel> dialog, which allow you to set-up vacation notifications.</para> +<note> +<para><guilabel>Out of Office reply</guilabel> functionality relies on server-side filtering. To be able to use it you need to configure the <link linkend="receiving-mail">Filtering tab</link> (see option relevant to kolab server) of your <guilabel>IMAP</guilabel> account set-up. +</para> +</note> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guisubmenu>Filter Log Viewer...</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Opens up the viewer window for the filter log; there you find some options to +control the logging of the filtering process. In the log you will find valuable +information about what filter rules were used, what was the result of the evaluation +of those rules, and which filter actions were applied to a message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Anti-Spam Wizard...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>It starts a <link linkend="the-anti-spam-wizard">wizard</link> which can help +you to set up spam filtering.</para> +</listitem> +</varlistentry> + +<!-- +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Anti-Virus Wizard...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>It starts a <link linkend="the-anti-virus-wizard">wizard</link> which can help +you to set up scanning messages for viruses.</para> +</listitem> +</varlistentry> +--> + +</variablelist> + +</sect2> + + +<sect2 id="reader-settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled, the Toolbar is visible (the Toolbar is the one with the icon +to compose a new message &etc;).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Quick Search</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled, the Quick Search bar which allows you to quickly search +for messages matching a search text is visible.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Filters...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the <link linkend="filters">Message Filters</link> window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure POP Filters...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the <link linkend="popfilters">Configure Pop Filters</link> window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a window that lets you configure the keyboard shortcuts for many +menu commands.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a window that lets you configure what happens when new mail arrives, +like playing a sound.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a window that lets you choose which icons are visible in the +toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kmail;...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens the <link linkend="configure">Configure</link> window.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="reader-help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +<para>These are the &kde; standard items for the <guimenu>Help</guimenu> menu:</para> + +&help.menu.documentation; + +<para>Additionally &kmail; offers these items:</para> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>&kmail; Introduction</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>This displays the welcome screen, which lists the most important +differences between your version of &kmail; and the previous one.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Tip of the Day</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>This displays a dialog with useful hints for using &kmail;.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> +</sect1> + +<sect1 id="composer-window-menus"> +<title>The Composer Window</title> + +<sect2 id="composer-file-menu"> +<title><guimenu>Message</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>New Composer</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up a new composer window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>New Main Window</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Creates a new main window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Return</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Send Now</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Sends the message immediately. If you use SMTP to send your +messages and the SMTP server is not reachable, the message will be put +into the outbox and you will get an error message. You can then later send +the messages in the outbox using <menuchoice><guimenu>File</guimenu><guimenuitem>Send +Queued Messages</guimenuitem></menuchoice>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>Send Later</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Queues the message in the outbox for sending it later using +<menuchoice><guimenu>File</guimenu><guimenuitem>Send +Queued Messages</guimenuitem></menuchoice>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Message</guimenu> +<guimenuitem>Save in Drafts Folder</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Save the message in the <guilabel>drafts</guilabel> folder so you can +later edit and send it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Messages</guimenu> +<guimenuitem>Insert File...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Inserts a text file into the message text, starting at the cursor +position.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Prints the current text.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></shortcut> +<guimenu>Message</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Closes this composer window.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="composer-edit-menu"> +<title><guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Undo your steps in editing the current message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Redo your steps in editing the current message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Cutting text works as with most editors: the selected text is +removed and put into the clipboard. Note that you can also select text and +drag it to a new position.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Copying text works as with most editors: the selected text is copied to the clipboard. +Note that you can also select text while holding the &Ctrl; key, and drag it to a new +position to copy it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Pasting works the same as with most editors: the text from the +clipboard is pasted at the current cursor position.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Selects all of the text in your message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a dialog to search for strings in the current message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Next</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Goes to the next occurrence of the previously searched string.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Replace...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a dialog that lets you replace strings in your message with other strings.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Clean Spaces</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>This replaces multiple line breaks or spaces with single line breaks or spaces. +It works on the current selection or on the complete message if there is no selection.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Paste as Quotation</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Pastes the text from the clipboard marked as quotation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Add Quote Characters</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Prepends the selected text with quotation marks.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Remove Quote Characters</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Removes the left-most quotation marks from the selected text.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="composer-view-menu"> +<title><guimenu>View</guimenu> Menu</title> + +<para>This menu lets you toggle the display of the header fields and other +options in this composer window.</para> + +<para>Options available are:</para> + +<itemizedlist> +<listitem> +<para><guimenuitem>All Fields</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Identity</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Dictionary</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Sent-Mail folder</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Mail Transport</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>From</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Reply To</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>To</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>CC</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>BCC</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Subject</guimenuitem></para> +</listitem> +</itemizedlist> + +<para>Currently visible items have a checkmark shown next to their name in the +menu.</para> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Use Fixed Font</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Uses a fixed width (monospaced) font to display the currently +edited message. The font to be used can be configured in the +<guilabel>Appearance</guilabel> section of &kmail;'s configuration +dialog.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="composer-options-menu"> +<title><guimenu>Options</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guimenuitem>Urgent</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Sets the priority of the message to Urgent. The receiver's email client has to support +this or it will have no effect. &kmail; itself does not support priorities for +incoming messages.</para> +</listitem> +</varlistentry> + + <varlistentry id="composer-options-request-mdn"> + <term> + <menuchoice> + <guimenu>Options</guimenu> + <guimenuitem>Request Disposition Notification</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + If you choose this option, you request a confirmation + email once your message is downloaded and read by its + recipient. This has to be supported and enabled by the + receiver's email client in order to work. + </para> + <para> + See <xref linkend="configure-security-reading-mdns"/> + for background information and ways to customize the + read receipts that &kmail; itself sends. + </para> + </listitem> + </varlistentry> + +<varlistentry id="composer-options-sign-message"> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guisubmenu>Sign Message</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Digitally sign the message using <application>OpenPGP</application>. +You can learn more about this in the <link linkend="pgp">chapter on OpenPGP</link>.</para> +</listitem> +</varlistentry> + +<varlistentry id="composer-options-encrypt-message"> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guisubmenu>Encrypt Message</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Encrypt the message using <application>OpenPGP</application>. +You can learn more about this in the <link linkend="pgp">chapter on OpenPGP</link>.</para> +</listitem> +</varlistentry> + + <varlistentry id="composer-options-select-crypto-message-format"> + <term> + <menuchoice> + <guimenu>Options</guimenu> + <guisubmenu>Select Cryptographic Message Format</guisubmenu> + </menuchoice> + </term> + <listitem> + <para> + Choose the cryptographic message format to use to + digitally sign and/or encrypt the message in. See <link + linkend="cryptographic-message-formats">the previous + description of each option</link> for more information. + </para> + </listitem> + </varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guisubmenu>Formatting (HTML)</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Enables &html; editing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guisubmenu>Set Encoding</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Set the charset encoding of this message. The chosen encoding will appear in the header of +the outgoing mail. You can use <guilabel>Auto</guilabel> for almost all +cases, &kmail; will tell you if you need to select a different encoding manually.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guimenuitem>Wordwrap</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Toggles the automatic wordwrap. It may be useful to turn it off if you want +to paste long lines that should not wrap.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Options</guimenu> +<guimenuitem>Automatic Spellchecking</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Toggles automatic spellchecking. Note that in &html;-editing mode +automatic spellchecking is not available.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + + +<sect2 id="composer-attach-menu"> +<title><guimenu>Attach</guimenu> Menu</title> + +<para>This menu lets you select attachment options.</para> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Append Signature</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Appends your signature (<quote>footer</quote>) to the end of the message. +<!-- fixme: nothing to do with crypto stuff --></para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Attach Public Key...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Attaches the corresponding <application>PGP</application>/<application>GnuPG</application> +key to your message.</para> +</listitem> +</varlistentry> + +<varlistentry id="composer-attach-attach-my-public-key"> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Attach My Public Key</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Attaches your <application>PGP</application>/<application>GnuPG</application> +public key to your message.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Attach File...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Attaches one or more files to the current message.</para> +<!-- fixme: not encrypted unless... --> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Remove Attachment</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Removes the attachment that is selected in the attachment part of the composer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Save Attachment As...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Saves the attachment that is selected in the attachment window to a +file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Attach</guimenu> +<guimenuitem>Attachment Properties</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Displays the <link linkend="attachments">properties of the attachment</link> that is selected in the +attachment window.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="composer-tools-menu"> +<title><guimenu>Tools</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Spelling...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Uses <ulink url="/kspell/">&kspell;</ulink> to check the spelling in the body of your +message. Note that +you have to configure &kspell; with <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Spellchecker...</guimenuitem></menuchoice> if you use it for the +first time.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Addressbook...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens up <ulink url="/kaddressbook/">&kaddressbook;</ulink>.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="composer-settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Main Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled, the Main Toolbar is visible, &ie; the one with the icon +to send the message &etc;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show HTML Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If enabled, the &html; Toolbar is visible, &ie; the one which with the +tools to change certain properties of the composed text.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Spellchecker...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Allows you to configure <ulink url="/kspell/">&kspell;</ulink>, &kde;'s spellchecker.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a window that lets you configure the keyboard shortcuts for many +menu commands.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens a window that allows you to decide which icons appear in the +toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kmail;...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Opens &kmail;'s <link linkend="configure">configuration dialog</link>.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + + +<sect2 id="composer-help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +<para>The entries in this menu have the same meaning as <link +linkend="reader-help-menu">the entries in the main window's help +menu</link>.</para> + +</sect2> +</sect1> + +</chapter> diff --git a/doc/kmail/using-kmail.docbook b/doc/kmail/using-kmail.docbook new file mode 100644 index 000000000..1d3b3e381 --- /dev/null +++ b/doc/kmail/using-kmail.docbook @@ -0,0 +1,2303 @@ +<chapter id="using-kmail"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Daniel</firstname> +<surname>Naber</surname> +<affiliation><address> +<email>daniel.naber@t-online.de</email> +</address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2004-09-24</date> +<releaseinfo>1.7.50</releaseinfo> +</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> +<term>Folder list (on the left)</term> +<listitem> +<para>This pane contains the list of your message folders (other email programs +may call them mailboxes). To select a folder, simply click on +it. The messages contained in the folder will now appear in the Headers +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 +entire left side of the screen but is able to show more mailboxes. You can toggle +between these two views under <guilabel>Appearance</guilabel>/<guilabel>Layout</guilabel> +in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice> dialog. Also see the <link +linkend="folders">Folders Section</link> for more information about how to use +folders.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Message list (in the upper right by default)</term> +<listitem> +<para>This pane lists header information (message Status Flags, Sender, Subject, +Date, and other optional columns like Size, Attachment Flag, Important Flag, etc.) +for the messages in the currently selected folder. Clicking on a header +will select that message and display it in the Message pane; you can also select +more than one message by holding down the &Ctrl; key when clicking on messages. +You may sort the messages by clicking on the column that you wish to +sort; if you click on the same column more than once, sort order will toggle +between ascending/descending and some alternative sorting criteria will become +available (like sorting by Status when you click on the header of the Subject column). +Clicking the <mousebutton>right</mousebutton> mousebutton on the list header shows a popup menu, +which allows to show or hide several columns in the list. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Message preview pane (in the lower right by default)</term> +<listitem> +<para>This pane displays the currently selected message. Attachments appear +at the bottom of the message, either as icons or embedded in the message, +depending on <menuchoice><guimenu>View</guimenu> +<guimenuitem>Attachments</guimenuitem></menuchoice>. For complex messages +the structure of the message is shown in the message structure viewer below +the preview pane. The placement of the preview pane as well as the placement +of the structure viewer can be changed under <guilabel>Appearance</guilabel>/<guilabel>Layout</guilabel> +in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice> dialog. Moreover, you can disable the +preview pane and you can choose when the message structure viewer should be +shown. +You can scroll through the message page-by-page +using the <keycap>Page Up</keycap> and <keycap>Page down</keycap> keys, or +line-by-line using the <keycap>up arrow</keycap> and <keycap>down arrow</keycap> +keys; you can also use <link linkend="keyboard-shortcuts">key shortcuts</link> to skip through +your messages without having to use the mouse.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Font type and font size</term> +<listitem> +<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> +</listitem> +</varlistentry> +<varlistentry> +<term>Delete Attachment</term> +<listitem> +<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> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="keyboard-shortcuts"> +<title>Keyboard Shortcuts</title> + +<para>The following keyboard shortcuts are supported in the main window:</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Keyboard Shortcut</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> +<row> +<entry><keycap>Space</keycap></entry> +<entry>Scroll down in the current message or go to the next unread message if you are already +at the bottom.</entry> +</row> +<row> +<entry><keycap>Right Arrow</keycap> or <keycap>N</keycap></entry> +<entry>Go to the next message in the current folder.</entry> +</row> +<row> +<entry><keycap>Left Arrow</keycap> key or <keycap>P</keycap></entry> +<entry>Go to the previous message in the current folder.</entry> +</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> +<entry><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></entry> +<entry>Go to the next folder with unread messages.</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></entry> +<entry>Go to the previous folder with unread messages.</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>Up Arrow</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;<keycap>Down Arrow</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">&Ctrl;<keycap>Left Arrow</keycap></keycombo></entry> +<entry>Walk upwards in the list of folders. Use +<keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> to actually +enter the folder.</entry> +<!-- TODO: or wait for timeout so the folder is selected? --> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>Right Arrow</keycap></keycombo></entry> +<entry>Walk downwards in the list of folders. Use +<keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo> to actually +enter the folder.</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>Space</keycap></keycombo></entry> +<entry>Enter the folder that has focus, &ie; the folder that you navigated +to using <keycombo action="simul">&Ctrl;<keycap>Left Arrow</keycap></keycombo> or +<keycombo action="simul">&Ctrl;<keycap>Right Arrow</keycap></keycombo>.</entry> +</row> +<row> +<entry><keycombo action="simul">&Shift;<keycap>Left Arrow</keycap></keycombo> and +<keycombo action="simul">&Shift;<keycap>Right Arrow</keycap></keycombo></entry> +<entry>Select messages in the header pane, starting with the current message.</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para>For more keyboard shortcuts have a look at the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem></menuchoice> dialog.</para> + +</sect1> + +<sect1 id="the-composer-window"> +<title>The Composer Window</title> + +<para>The composer window is used to write new messages; +it can be invoked via <menuchoice><guimenu>Message</guimenu> +<guimenuitem>New Message...</guimenuitem></menuchoice> +menu or from the <guiicon>New Message</guiicon> icon on the main +window.</para> + +<sect2 id="composing-a-message"> +<title>Composing a Message</title> + +<para>To write your message, fill in the appropriate fields in the +composer window. Use the <guimenu>View</guimenu> menu +to select which header fields are displayed. The <guimenuitem>Identity</guimenuitem> +field offers a <guibutton>Sticky</guibutton> option; if it is checked, +the current identity will become the default identity when you open +a new composer next time.</para> + +<para>There are a variety of shortcuts to help +you with writing your messages. The <guibutton>...</guibutton> buttons next to +the <guilabel>To:</guilabel>, <guilabel>CC:</guilabel>, and +<guilabel>BCC:</guilabel> fields will call up the address book so that you can +select addresses from there.</para> + +<para>When you start typing an address in the +<guilabel>To:</guilabel>/<guilabel>CC:</guilabel>/<guilabel>BCC:</guilabel> +fields, a popup will appear that offers matching addresses that have been used recently +and matching addresses from your address book. If you use multiple addressbooks, you can +use the TAB key to select the first entry of the next addressbook in the list. +If you do not like the automatic popup you can disable it by clicking with the &RMB; on the field and choosing +a different completion mode.</para> + +<para>Whenever you want to add more than one +recipient in one of the fields, use a comma to separate each address +from the next one. +<!-- fixme: there's now a setting for this: --> +You may need to specify fully qualified addresses +(&ie; <userinput>user@example.com</userinput>) even for local +users, depending on your system configuration.</para> + +<para>When you are finished with your +message, click the <guiicon>Send Now</guiicon> icon (the envelope) to send +the message now, or click the <guiicon>Send Later</guiicon> icon to put +the message in the outbox. If your message is not finished yet, select +<menuchoice><guimenu>Message</guimenu><guimenuitem>Save in Drafts +Folder</guimenuitem></menuchoice>. +</para></sect2> + +<sect2 id="encrypt-sign"> +<title>Signing and Encrypting Messages</title> + +<para> + If you want to send an <link +linkend="pgp-encrypt-your-messages">encrypted</link> +or <link linkend="pgp-sign-your-messages">digitally signed</link> message, select the +<guiicon>Sign Message</guiicon> or <guiicon>Encrypt +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 +installed encryption programs you can choose between: +</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 +message. The preferred format of the recipients can be specified in the +KDE Address Book.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Inline OpenPGP (deprecated)</guilabel></term> +<listitem> +<para>This format is outdated. If you use this format then only the +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 +if necessary, &ie; if you send messages to users of email clients that cannot +handle the more advanced formats.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>PGP/MIME</guilabel></term> +<listitem> +<para>This format is the successor of the inline OpenPGP format. If you +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 +use OpenPGP.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>S/MIME</guilabel></term> +<listitem> +<para>This format is an alternative format to PGP/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 +corporations.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>S/MIME opaque</guilabel></term> +<listitem> +<para>This format is a variant of the S/MIME format. It should only be +used if necessary.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="html-mails"> +<title>Creating HTML Messages</title> + +<para>Note that HTML messages are often regarded as an annoyance; therefore, +you should avoid sending HTML messages if possible. Particularly, you should never +send HTML messages to a mailing list unless HTML messages are explicitly +allowed.</para> + +<para>In order to be able to create HTML messages you first have to enable +the markup tools. To do this enable <guimenuitem>Formatting (HTML)</guimenuitem> in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu. +A toolbar with several tools to +format the message will appear. Via the drop down box you can select between +standard text and six different types of lists (three bulleted lists with +different symbols and three numbered lists with different numbering). +Moreover, you can select the font family, the font size, the font style (bold, +italic, underlined) and the text color. Last but not least, you can select +the alignment of the text (left aligned, centered, right aligned).</para> + +<para>Creating tables and embedding images is currently not possible.</para> + +</sect2> + +<sect2 id="attachments"> +<title>Adding Attachments</title> + +<para>You can attach files to your message by using one of the methods +below:</para> + +<itemizedlist> +<listitem> +<para>Click the <guiicon>Attach File</guiicon> (paper clip) icon and select the file you wish +to attach;</para> +</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 +window -- that message will then be attached;</para> +</listitem> +<listitem> +<para>Select one of the options in the +<menuchoice><guimenu>Attach</guimenu></menuchoice> menu.</para> +</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 +&RMB; on each attachment to <guimenuitem>View</guimenuitem>, +<guimenuitem>Save</guimenuitem> or <guimenuitem>Remove</guimenuitem> +the attachment.</para> + +<para>Use the <guimenuitem>Properties</guimenuitem> item to +open the <guilabel>Message Part Properties</guilabel> dialog. +The first field contains the attachment's &MIME; type. Just like the <guilabel>Name</guilabel> +field, it should be automatically filled with an appropriate value. Sometimes the +&MIME; type value may be wrong. You can then type in any &MIME; type or +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 +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 +and on his settings.</para> + +<para>You can also attach public keys to the message by using the appropriate options in the +<menuchoice><guimenu>Attach</guimenu></menuchoice> menu. <application>PGP</application> +key attachments are handled like file attachments.</para> + +</sect2> + +<sect2 id="checking-the-spelling-of-your-message"> +<title>Checking the Spelling of your Message</title> + +<para>&kmail; will automatically check the spelling of your message (in +HTML mode this currently does not work) +and display unknown words using red color. If there are too many +unknown words &kmail; will disable its checking. To select the language +used for checking, select <menuchoice><guimenu>View</guimenu> +<guimenuitem>Dictionary</guimenuitem></menuchoice>. You can disable +automatic spellchecking in the <menuchoice><guimenu>Options</guimenu></menuchoice> menu.</para> + +<para>To check the spelling of your message using a dialog, select +<menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Spelling...</guimenuitem></menuchoice>. &kmail; uses +<ulink url="/kspell/">&kspell;</ulink> to +check spelling, which is the &kde; frontend to the +<application>ispell</application> or <application>aspell</application> spelling +checker. Note that you may first need to configure the spellchecker using +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Spellchecker...</guimenuitem></menuchoice>.</para> + +</sect2> + +</sect1> + +<sect1 id="folders"> +<title>Message Folders</title> + +<para>Message Folders are used to organize your email messages. By default, +if you have no existing message folders, messages are stored in the folder +<filename +class="directory">$<envar>KDEHOME</envar>/share/apps/kmail/</filename>. If +you have existing message folders in <filename +class="directory">~/Mail</filename>, these will be used instead. When you +first start &kmail; the <guilabel>inbox</guilabel>, +<guilabel>outbox</guilabel>, <guilabel>sent-mail</guilabel>, +<guilabel>trash</guilabel> and <guilabel>drafts</guilabel> folders are +created. These folders each have special functions:</para> + +<variablelist> +<varlistentry> +<term><guilabel>inbox:</guilabel></term> +<listitem> +<para>Where &kmail; by default puts your new messages when you ask it to check your +mail. </para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>outbox:</guilabel></term> +<listitem> +<para>Where messages are put while they are waiting to be delivered. Note that +you should not drag and drop messages here to send them, use the <guiicon>Send</guiicon> +icon in the composer window instead.<!-- fixme 3.2: has this been 'fixed'? --></para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>sent-mail:</guilabel></term> +<listitem> +<para>By default copies of all messages that you have sent are put into this folder.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>trash:</guilabel></term> +<listitem> +<para>By default all messages that you have moved to trash are moved into this folder.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>drafts:</guilabel></term> +<listitem> +<para>Contains messages you started to edit but then saved to this +folder instead of sending them.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You may find that the standard folders are fine for your +needs; eventually, though, you will probably need folders to help you organize +your messages. To create a new folder, select +<menuchoice><guimenu>Folder</guimenu><guimenuitem>New Folder...</guimenuitem></menuchoice>: +the <link linkend="folders-properties-window">folder properties</link> dialog +will then prompt you for the necessary information. If you ever need to change +the settings for a folder, select the folder you wish to modify in the Folders pane and select +<menuchoice><guimenu>Folder</guimenu><guimenuitem>Properties</guimenuitem> +</menuchoice>.</para> + +<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 +<menuchoice><guimenu>Message</guimenu><guimenuitem>Move +To</guimenuitem></menuchoice>. A list of folders will appear; select the folder +from the list that you want to move the messages to. Messages can also be moved +by dragging them from the Message list to a folder in the Folder list.</para> + +<para>If you want to clear all of the messages out of a folder choose +<menuchoice><guimenu>Folder</guimenu><guimenuitem>Move All Messages to +Trash</guimenuitem></menuchoice>. You can use +<menuchoice><guimenu>Folder</guimenu><guimenuitem>Delete Folder</guimenuitem></menuchoice> +to remove a folder and all its messages and subfolders.</para> + +<para>Folders can be copied or moved by using either drag and drop or the <menuchoice> +<guimenuitem>Copy Folder</guimenuitem></menuchoice> and <menuchoice> +<guimenuitem>Move Folder</guimenuitem></menuchoice> context menu entries. Note that you cannot +move the above listed special folders. +</para> + +<sect2 id="folders-properties-window"> +<title>Folder Properties</title> + +<para>The folder's <guilabel>Properties</guilabel> dialog lets you rename and move +a folder and specify all of its properties. Note that most properties +are only available for your own folders and not for default folder like +<guilabel>inbox</guilabel> &etc;. Default folders also cannot be moved +or renamed.</para> + +<sect3 id="folders-properties-general"> +<title>General</title> + +<para>Rename a folder by changing the entry in the <guilabel>Name:</guilabel> field.</para> + +<para>You can make a folder a subfolder of another folder by choosing a new parent +folder using the <guilabel>Belongs to</guilabel> selection. </para> + +<para>The <guilabel>Folder Icons</guilabel> section lets you choose +icons that are different from the default ones in the folder list.</para> + +<para>See the <link linkend="folders-format">Folder Format</link> section +for information about the <guilabel>Mailbox format.</guilabel></para> + +<para>With the <guilabel>Identity</guilabel> section you can set the default +identity that should be used for new messages if this folder is selected. +Replies to messages that were sent directly +to you will still default to the message's <quote>To</quote> address if an +according identity is found.</para> + +<para>With <guilabel>Show Sender/Receiver</guilabel> you can set the +visible columns in the header pane. This is useful if you use a +folder to save your own sent messages.</para> + +<para>Check <guilabel>Ignore new mail in this folder</guilabel> if you do not +want to be informed about new mail that arrives in this folder. This is for +example useful for the folder where you move all detected spam messages to.</para> + +<para>Check <guilabel>Keep replies in this folder</guilabel> if you want +replies to messages in this folder to be filed also into this folder rather +than into a special sent-mail folder.</para> + +<para>For calendar folders you can select who should get reminders for the contained +events by using the <guilabel>Generate free/busy and activate alarms for</guilabel> +choice box.</para> + +<para>In case you don't want to receive reminders for folders shared by someone else, +you can block them locally by activating the <guilabel>Block free/busy and alarms locally</guilabel> +checkbox.</para> + +</sect3> + +<sect3 id="folders-properties-expiry"> +<title>Old Message Expiry</title> + +<para>Here you can select what should happen with old messages in this +folder. If you enable <guilabel>Expire old messages in this folder</guilabel> +then &kmail; will regularly, depending on your choice, either delete old +messages or move old messages to another folder. You can also start +expiration of old messages manually via <menuchoice><guimenu>Folder</guimenu><guisubmenu>Expire</guisubmenu></menuchoice> and via +<menuchoice><guimenu>File</guimenu><guisubmenu>Expire +All Folders</guisubmenu></menuchoice></para> + +<warning><para>Messages that are deleted during expiration of old messages +cannot be restored, so be careful with this setting.</para></warning> + +</sect3> + +<sect3 id="folders-properties-mailinglist"> +<title>Mailing List</title> + +<para>If you are going to use the folder for a mailing list 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 between:</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 + webpage. + </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 webpage. + </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 webpage. + </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> you +enter the email address or the address of the webpage and then click on +<guilabel>Add</guilabel>. With <guilabel>Remove</guilabel> you can remove +addresses.</para> + +<para>If all addresses have been added then you can execute an action, ⪚ +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 webpage for the desired action then 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 webpage.</para> + +<para>Alternatively to invoking the handler for +<guilabel>Post to List</guilabel> you can send a new message to the +mailing list via <menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message to Mailing-List...</guimenuitem></menuchoice> or by clicking with +the <mousebutton>middle</mousebutton> mousebutton on the folder in the folder +list.</para> + +</sect3> + + <sect3 id="folders-properties-acl"> + <title>Access Control tab (&imap; only)</title> + + <para> + Here you can manage the access control lists (&acl;s) of + &imap; folders. + </para> + + <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> + <para> + Note that a single <guilabel>User Id</guilabel> might + refer to more than one user. Depending on the &imap; + server and its configuration, there may be User Ids + that correspond to groups of users, anonymous users, or + any user. Consult the manual of your specific &imap; + server implementation for more information. + </para> + </footnote> + &acl;s are settable per-folder. + </para> + + <note> + <para> + As with everything else when using <emphasis>disconnected + &imap;</emphasis>, you need to sync with the server for + the changes to be transferred to the server. + </para> + </note> + + <para> + &imap; &acl;s define a lot of fine-grained permissions that + you can grant or deny other users. For the sake of clarity, + &kmail; will present them as the following five categories + that you can choose from (see <xref + linkend="table-acl-summary"/> for the details if you already + know &imap; &acl;s). + </para> + + <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 &imap; folders presented to + them by their mail clients. + </para> + </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 its 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> + <para> + These users will see this folder in the list of &imap; + folders presented to them by their mail clients. + </para> + <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 can not 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 (⪚ + 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 + acting as moderators, which would then be able to + remove off-topic posts, and create sub-topic-folders + for high-traffic folders. + </para> + </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> + + <para> + <xref linkend="table-acl-summary"/> summarizes the &imap; + &acl; rights associated with each permission level. + </para> + + <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> + +<sect2 id="folders-format"> +<title>Folder Format</title> + +<para>A message folder can be either in <guilabel>mbox</guilabel> or in <guilabel>maildir</guilabel> +format. <guilabel>mbox</guilabel> saves all messages of a folder to one file, +whereas <guilabel>maildir</guilabel> saves each message to its own file. +<guilabel>maildir</guilabel>, which is the default format, can be considered more +robust, but it can be slower on some file systems. If you are unsure, +choose <guilabel>maildir</guilabel>.</para> + +<para>Note that there is currently no feature in &kmail; that allows you to convert +between both formats automatically, but you can just move all messages from an old +<guilabel>mbox</guilabel> folder to a new <guilabel>maildir</guilabel> folder or +vice-versa.</para> + +</sect2> + +</sect1> + +<sect1 id="filters"> +<title>Message Filters</title> +<anchor id="filters-id"/> + +<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> + +<para>Please note that the filters described in this section are +applied <emphasis>after</emphasis> the messages have been downloaded +from your account -- if you want to filter messages on the server, see +<link linkend="popfilters">Download Filters</link>.</para> + +<para>Filters consist of: filter criteria, whose rules are used as +criteria 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. Read more +about filter criteria and filter actions in the following +subsections.</para> + +<note><para>Filters are considered one after the other, +starting with the first filter in the list. The first one whose +pattern matches the given message gets executed; you can request that +the remaining filters also be applied, but the default is to stop +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 +Filters</guimenuitem></menuchoice>: this will apply all filters that +have been marked for manual filtering in the <link +linkend="filter-dialog">filter dialog</link> to those messages.</para> + +<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 +Filter</guimenuitem></menuchoice>: this will call the filter dialog +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 +should be moved to; but you can, of course, edit the filter as you +like.</para> + +<para>When creating a filter on mailing list messages this method +will try really hard to find a criterion that +uniquely identifies messages from that list; If it succeeds, the guessed +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> +</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 four main sections:</para> +<variablelist> +<varlistentry> +<term><guilabel>Available Filters</guilabel></term> +<listitem><para>This group contains the list of filters and some action +buttons to modify the filters, namely: to create new filters; to move them up or +down the list; to delete them; or to rename them. If you select +a filter from the list, its properties are shown in the right-hand half +of the dialog.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Filter Criteria</guilabel></term> <listitem><para>In +this group you can edit the pattern that messages must match for the +filter to be applied to them. You can select here whether all of the +defined rules must match or whether it suffices that any one of them +matches. See <link linkend="filter-criteria">Search Patterns</link> +below for a detailed description of each search rule type.</para> + +<para> You can click on <guibutton>More</guibutton> to get an +additional (initially empty) rule if you want to define more-complex +patterns and on <guibutton>Fewer</guibutton> to remove the last +rule. <guibutton>Clear</guibutton> clears the pattern, &ie; it removes +all but two rules from screen and resets those two.</para> +<para>Invalid or empty rules are not evaluated.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Filter Actions</guilabel></term> <listitem><para>In +this group you can edit the list of actions that are applied to all +messages that match the defined filter criteria. See <link +linkend="filter-action">Filter Actions</link> below for a detailed +description of each action type.</para> + +<para> You can click on <guibutton>More</guibutton> to get a new, +empty action (if you want to define more than one action) and on +<guibutton>Fewer</guibutton> to remove the last +action. <guibutton>Clear</guibutton> clears the list, &ie; it +removes all but one action and resets that one.</para> +<para>Invalid or empty actions are not executed.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Advanced Options</guilabel></term> + +<listitem> + +<para>In this group you can define a few advanced options for filters +that allow you to refine your filtering.</para> + +<para>Using the first row of check boxes, you can toggle when the +filter is applied: the <guilabel>to incoming messages</guilabel> +option means that the filter is applied to messages when you receive +them (&ie; on <guiicon>Check Mail</guiicon>); the <guilabel>to sent +messages</guilabel> options means that the filter is applied to +messages when you send them and the <guilabel>on manual +filtering</guilabel> option controls whether to apply this filter when +filtering is specifically selected (&ie; via +<menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply +Filters</guimenuitem></menuchoice>.)</para> + +<para>The <guilabel>If this filter matches, stop processing here</guilabel> +check box in the second row controls whether or not the filters after +the current filter will be applied, if the current filter matches.</para> + +<para>If the <guilabel>Add this filter to the Apply Filter menu</guilabel> +check box in the third row is selected, this filter will be inserted +in the <menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply +Filter</guimenuitem></menuchoice> submenu. You can then apply this +filter to a message. Another way of applying filters is to use +<menuchoice><guimenu>Message</guimenu> <guimenuitem>Apply +Filters</guimenuitem></menuchoice> menu option, which applies <emphasis>all</emphasis> +the filters - one after another until they are all used or one of the +filters that matches has the <guilabel>If the filters matches, stop +processing here</guilabel>.</para> + +</listitem> +</varlistentry> +</variablelist> + +<note><para>Filters are automatically named unless you explicitly +rename them using the <guibutton>Rename...</guibutton> button. +The dialog assumes that it should continue auto-naming the filter +as long as the filter name starts with <quote><</quote>. +</para></note> + +<note> +<para>If you apply filter changes, via +<guibutton>OK</guibutton> or <guibutton>Apply</guibutton>, only valid +filters are actually copied to the internal filter manager.</para> + +<para>Similarly, empty rules and actions are removed from the pattern +and action list respectively, before the filter is saved.</para> +</note> + +</sect2> + +<sect2 id="filter-criteria"> +<title>Search Patterns</title> + +<para>The most common use of filters is to filter on the sender of +messages; this can be done by choosing <guilabel>From</guilabel>. A +good bet for a mailing list would be +<guilabel><recipients></guilabel>, but there are other criteria +a filter can search for (note that all patterns are interpreted +case-insensitively):</para> + +<variablelist> +<varlistentry> +<term><guilabel><message></guilabel></term> +<listitem> +<para>Searches the whole message (&ie; headers, body and attachments, +if any);</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><body></guilabel></term> +<listitem> +<para>Searches the body of the message (&ie; the whole message except the headers);</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><any header></guilabel></term> +<listitem> +<para>Searches the headers of the message;</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><recipients></guilabel></term> +<listitem> +<para>Searches the <quote>To</quote> and <quote>CC</quote> header fields of the message;</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><size in bytes></guilabel></term> +<listitem> +<para>Sets upper or lower bounds on the message size;</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><age in days></guilabel></term> +<listitem> +<para>Sets upper or lower bounds on the message age;</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel><status></guilabel></term> +<listitem> +<para>Sets restrictions on the status of the message;</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Any other name</term> +<listitem> +<para>Searches the header field that is given by that name.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>The list of possible rules depends on what you selected in the first +drop down box. The available rules are:</para> + +<informaltable> +<tgroup cols="3"> +<thead> +<row> +<entry>Rule</entry> +<entry>Available for</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry><guilabel>contains</guilabel>/<guilabel>does not contain</guilabel></entry> +<entry>all textual search items</entry> +<entry>Matches if the searched item contains (or does not contain) the given +text.</entry> +</row> +<row> +<entry><guilabel>equals</guilabel>/<guilabel>does not equal</guilabel></entry> +<entry>most textual search items</entry> +<entry>Matches if the searched item is equal to (or not equal to) the given +text.</entry> +</row> +<row> +<entry><guilabel>matches regular expr.</guilabel>/<guilabel>does not match reg. expr.</guilabel></entry> +<entry>all textual search items</entry> +<entry>Matches if a part of the searched item matches the given regular +expression (or does not match it). If the regular expression editor is +installed then you can edit the regular expression by clicking on the <guilabel>Edit...</guilabel> button.</entry> +</row> +<row> +<entry><guilabel>has an attachment</guilabel>/<guilabel>has no attachment</guilabel></entry> +<entry><guilabel><message></guilabel></entry> +<entry>Matches if the message has an attachment (or does not have an attachment).</entry> +</row> +<row> +<entry><guilabel>is in address book</guilabel>/<guilabel>is not in address book</guilabel></entry> +<entry>most textual search items</entry> +<entry>Matches if the searched item contains an address that is in your address +book (or if the searched items contains only unknown addresses). Of course, +this rule makes only sense for address fields like From or +<guilabel><recipients></guilabel></entry> +</row> +<row> +<entry><guilabel>is in category</guilabel>/<guilabel>is not in category</guilabel></entry> +<entry>most textual search items</entry> +<entry>Matches if the searched item contains an address that is in the +specified category in your address book (or if the searched item contains +no address that is in the specified category). Again, this rule makes only +sense for address fields.</entry> +</row> +<row> +<entry><guilabel>is equal to</guilabel>/<guilabel>is not equal to</guilabel></entry> +<entry>numerical search items</entry> +<entry>Matches if the value of the search item is equal to (or not equal to) +the specified value.</entry> +</row> +<row> +<entry><guilabel>is less than</guilabel></entry> +<entry>numerical search items</entry> +<entry>Matches if the value of the search item is less than +the specified value.</entry> +</row> +<row> +<entry><guilabel>is greater than</guilabel></entry> +<entry>numerical search items</entry> +<entry>Matches if the value of the search item is greater than +the specified value.</entry> +</row> +<row> +<entry><guilabel>is less than or equal to</guilabel></entry> +<entry>numerical search items</entry> +<entry>Matches if the value of the search item is less than or equal to +the specified value.</entry> +</row> +<row> +<entry><guilabel>is greater than or equal to</guilabel></entry> +<entry>numerical search items</entry> +<entry>Matches if the value of the search item is greater than or equal to +the specified value.</entry> +</row> +<row> +<entry><guilabel>is</guilabel>/<guilabel>is not</guilabel></entry> +<entry><guilabel><status></guilabel></entry> +<entry>Matches if the message has (or does not have) the specified status.</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="filter-action"> +<title>Filter Action</title> + +<para>The most common use of filters is to sort incoming messages to +certain folders; this can be done by choosing <guilabel>Move into +Folder</guilabel>. Here is a list of all possible actions:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Move into Folder</guilabel></term> +<listitem> +<para>This will file the message into another folder, removing it from +its current folder if necessary; you cannot, currently +use &imap; folders as a target.</para> +<!-- fixme: still correct? --> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Copy to Folder</guilabel></term> +<listitem> +<para>This will copy the message to another folder.</para> +<note><para>You currently cannot use &imap; +folders as a target.</para></note> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Set Identity To</guilabel></term> +<listitem> +<para>This will set the identity that will be used if you reply to this +message.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Mark As</guilabel></term> +<listitem> +<para>This allows you to mark the message as read or important (flagged), but +also as forwarded, replied, &etc;</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Send Fake MDN</guilabel></term> +<listitem> +<para>This will send a faked message disposition notification (&ie; a read +receipt) to the sender of the message.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Set Transport To</guilabel></term> +<listitem> +<para>This will set the method of transport (⪚ <acronym>SMTP</acronym>) +that will be used if you reply to the message.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Set Reply-To To</guilabel></term> +<listitem><para>This will modify the <guilabel>Reply-To</guilabel> field of this +message. This can be useful for mailing lists that automatically set a Reply-To +which you do not like.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Forward To</guilabel></term> +<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.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Redirect To</guilabel></term> +<listitem><para>This will redirect the message as-is to another email address.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Confirm Delivery</guilabel></term> +<listitem><para>Will try to return a message to the sender that +indicates successful delivery of their message, if the sender requested that.</para> <para>This +action allows you to select who will get delivery receipts from +you. <!-- FIXME: removed-->Though you can globally enable the sending of delivery +confirmations in the <guilabel>Configure &kmail;...</guilabel> dialog +(<link linkend="configure-security"><guilabel>Security</guilabel> +page</link>) we recommended not to send them to everyone, since this +makes tracking of spam messages, for example, very easy for the sender.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Execute Command</guilabel></term> +<listitem> +<para>This will execute a program, but will not modify the +message. Specify the full path to the program you want to +execute; &kmail; will then block until the program returns. +If you do not want &kmail; to block then append '&' to the command. +You can feed +the program with the parts of the mail: <symbol>%0</symbol>, +<symbol>%1</symbol>, &etc; stand for files representing +the message parts; for common messages <symbol>%0</symbol> is the +text, <symbol>%1</symbol> the first attachment and so +on. Additionally, the whole message is fed into the program's +<acronym>stdin</acronym>; and every occurrence of +<symbol>%{foo}</symbol> is replaced by the content of the foo +header.</para> + +<!-- fixme: still correct? --> +<warning><para>This currently only works if the message has +<emphasis>at least one</emphasis> attachment. No, not even +<symbol>%0</symbol> will work in the general +case!</para></warning> + +<tip><para> You can enter arbitrarily-complex shell commands here, +since &kmail; uses a sub shell to execute the command line; therefore, +even this command will work (within its limits): +<userinput><command>uudecode</command> <option>-o</option> +<parameter>$(mktemp kmail-uudecoded.XXXXXX)</parameter> && +<command>echo</command> <parameter>$'\a'</parameter></userinput></para></tip> +<!-- fixme: is this uudecode tip useless now?? --> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Pipe Through</guilabel></term> +<listitem> +<para>This will feed the message to a program: if the program returns +output, the entire message (including the headers) will be replaced +with this output; if the program does not return output or exits +with a return code other than 0 (indicating an error occurred), the message +will not change. Specify the full path to the program. The same +substitutions (<symbol>%n</symbol>, +<symbol>%{foo}</symbol> as with <guilabel>execute +command</guilabel> are performed on the command line.</para> +<warning><para>Be cautious with this action, as it will easily mess up +your messages if the filter program returns garbage or extra +lines.</para></warning> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Remove Header</guilabel></term> +<listitem> +<para>Will remove all header fields with the +given name from the message. This is useful mainly for removing bogus +<quote>Reply-To:</quote> headers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Add Header</guilabel></term> +<listitem> +<para>If no such field is already present this will add a new header field +with the given name and value to the message; if there already is a +header field with that name, it is overwritten with the +given value; if there are already multiple headers with the given +name (⪚ <quote>Received:</quote> headers), an arbitrary one of them is +overwritten and the others are left unchanged -- this is a known +limitation. You may want to combine this filter with the +<guilabel>remove header</guilabel> filter above to make sure that +there are no other headers with that name in the message.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Rewrite Header</guilabel></term> +<listitem> +<para>Will scan the given header field, modify its contents and write +it back. The search string is always interpreted as a case-sensitive +regular expression. The replacement string is inserted literally +except for occurrences of <userinput>\n</userinput>, +<userinput>$n</userinput> and <userinput>${nn}</userinput>, where +<userinput>n</userinput> is a positive (single-digit, except for the +third form) number or <userinput>0</userinput>. These constructs are +interpreted as back references to substrings captured with parentheses +in the search string.</para><para>Analogous restrictions as in the +<guilabel>add header</guilabel> action apply here, too.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Play Sound</guilabel></term> +<listitem> +<para>Will play the specified sound.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="filter-examples"> +<title>Filter Examples</title> + +<para>If I am subscribed to the (general) &kde; List, I could create a +folder for the list (I will call it +<replaceable>KDE-General</replaceable>) and use a filter to +automatically transfer new messages from my inbox to my +<replaceable>KDE-General</replaceable> folder if they are from the +&kde; List. Here is how to create this filter:</para> + +<procedure> +<title>Filtering a mailing list</title> +<step> +<para>Try if <menuchoice><guimenu>Message</guimenu><guisubmenu>Create +filter</guisubmenu><guimenuitem>Filter on +Mailing-List...</guimenuitem></menuchoice> can identify the mailing +list (the name of the list should then appear in the menu item); in +this case, this works and I am presented a filter that has +<quote>List-Id<guilabel>contains</guilabel> +<kde.kde.org></quote> preset. You select the +desired destination folder from the folder pull-down menu in the +<guilabel>Filter Action</guilabel> group and that is it.</para> + +<para>If that does not work, think of a unique way of identifying the +messages you want to filter. The (almost) unique property of my &kde; +List messages is that they always contain +<quote>kde@kde.org</quote> in the +<guilabel>To:</guilabel> or <guilabel>CC:</guilabel> field. It is only +almost unique, because this fails for cross-posted messages.</para> +</step> +<step> +<para>Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Filters...</guimenuitem></menuchoice>.</para> +</step> +<step> +<para>Press the <guibutton>New</guibutton> button to create an empty +filter. It will appear as <guilabel><unknown></guilabel>.</para> +</step> +<step> +<para>In the <guilabel> Filter Criteria</guilabel> area, select +<guilabel><recipients></guilabel> from the first drop-down box, +<guilabel>contains</guilabel> from the second drop-down box, and type +<userinput>kde@kde.org</userinput> in the text +field.</para> +</step> +<step> +<para>Skip down to the <guilabel>Filter Actions</guilabel> section. Select <guilabel>file into +folder</guilabel> from the first drop-down box. A new drop-down box +containing a list of folders will appear. Select the folder that you +want the filtered messages to be transferred to. For this example, you would select +<guilabel>KDE-General</guilabel> from the drop-down box.</para> +</step> +</procedure> + +<para>You may find that you need to use more powerful criteria to +properly filter your messages; for example, you may only want to +filter the &kde; List messages that are written by your friend <replaceable>Fred +Johnson <fj@anywhere.com></replaceable>. This is where the rest of the +matching criteria section comes into play:</para> + +<procedure> +<title>Extending the filter</title> +<step> +<para>Open up the <guilabel>Configure Filters...</guilabel> window and select +the filter you just created.</para> +</step> +<step> +<para>Since you want to filter all messages that have +<replaceable>kde@kde.org</replaceable> in the +<guilabel>To:</guilabel> or <guilabel>CC:</guilabel> field +<emphasis>and</emphasis> that are from Fred, check the +<guibutton>Match all of the following</guibutton> radio +button.</para> +</step> +<step> +<para>Now, go to the second search rule and select the following from +the pull-down menus: <guilabel>From</guilabel>, +<guilabel>contains</guilabel>. Now, type +<userinput>fj@anywhere.com</userinput> in the text field.</para> +</step> +</procedure> + +<para>You now have a filter that transfers all &kde; List messages +that are from <userinput>fj@anywhere.com</userinput>.</para> +<!-- fixme: trigger with ctrl-j or whenever new mail arrives (unless +<guilabel>Advanced Options</guilabel> are changed. --> +</sect2> + +<sect2 id="filter-optimization"> +<title>Filter Optimization</title> + +<para>It is important to know that, for example, the order of the +filters has an impact on the speed of the filter process. Here are +some ideas which can help you to improve the filtering: +</para> + +<variablelist> +<varlistentry> +<term>Stop filter processing as early as possible:</term> +<listitem> +<para>If you know that a filter finally processes a certain class of +messages, please make sure to check the option <guilabel>If this filter +matches, stop processing here</guilabel> for the filter. +This will avoid the evaluation of the filter rules of all subsequent +filters. (See the advanced options in the <link linkend="filter-dialog-id"> +Filter Dialog</link>).</para> +<para>An example is filtering messages from mailing lists via List-Id +header into separate folders. Having found out that a message came from +list A means that you can avoid checking the next filter for messages +from list B. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Consider the costs of the evaluation of filter rules:</term> +<listitem> +<para>The time required to evaluate a filter rule depends on the way +the rule is constructed. In particular, scanning for a +substring using the <guilabel>contains</guilabel> operation is faster +than a pattern matching using the <guilabel>matches regular +expr.</guilabel> operation. +</para> +<para>Another dependency is on the amount of data which is used for the +evaluation of a filter rule. If the rule is based on a message header, +its evaluation should normally be much faster than the evaluation of +a rule based on the complete message. +</para> +<para>You should try to keep the filter rules as simple as possible. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term>Check the order of your filters:</term> +<listitem> +<para>All the different filter actions have a different complexity. +The most expensive filter actions are <guilabel>pipe through</guilabel> +and <guilabel>execute command</guilabel>, because both need external +programs to be run. Placing filters containing these filter actions +behind other filters that can reduce the number of times these complex +actions are required is useful, if the filter logic does allow +this.</para> +<para>An example is filtering messages from a mailing list and detecting +spam messages. For the spam detection you will usually use an external +tool via a <guilabel>pipe through</guilabel> action. Filtering the messages +for the mailing list is done via the List-Id header. If you do not want to +check the messages from the mailing list for spam too, it is better to +use the filter for the mailing list messages before the filter for the +spam detection. This way you avoid the expensive and slow spam check for all +messages which were identified as mailing list messages. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="filter-logging"> +<title>Filter Log</title> +<para>If you want to verify that your filters work as intended, you can +open a viewer for the filter log via <menuchoice><guimenu>Tools</guimenu> +<guimenuitem>Filter Log Viewer...</guimenuitem></menuchoice>. +</para> +<para>In the viewer, there you can configure the logging of the filter +processing. You can control the detail level of the log, clear the log +or save the log into a file. The log can provide valuable information if +you need to debug your filtering process. +</para> +</sect2> +</sect1> + +<!-- dnaber update 2004-02-22 --> +<sect1 id="popfilters"> +<title>Download Filters</title> + +<para>Download Filters can be used to filter mail from a POP server, +<emphasis>before</emphasis> they are completely downloaded; you can use them +to prevent &kmail; from downloading huge messages and save time this +way.</para> + +<para>In the configuration dialog of the POP account you can enable +download filtering by checking the <guilabel>Filter messages if +they are greater than</guilabel> box; once you have done that, you can specify a size +which is used as a threshold: messages exceeding this size will be +checked against the filter rules you defined -- if no filter rule +matches, they will be shown in a confirmation dialog and you can +decide what to do with them. The default size for filtering is 50,000 +Bytes; this is a good value as the overhead is kept to a minimum -- +every message that is looked at by the filter causes additional +traffic because the header of the message is downloaded twice. The +default action is <guilabel>Download mail</guilabel> to prevent the +loss of messages.</para> + +<warning><para>Be careful with the <guilabel>Delete mail from +server</guilabel> option since once a mail is deleted on the server +there is no way to get it back.</para></warning> + +<para>With a really good set of filter rules, it is possible that all +messages that exceed the threshold size are automatically tagged +(&ie; downloaded, kept on the server or deleted) and you would never +be bugged by the confirmation dialog. Be careful though, since once a +message is matched by a filter rule, you have no guarantee that you +can change the action before it is executed: the confirmation dialog will +be displayed <emphasis>only</emphasis> if there is a message left that +was not matched by a filter rule.</para> + +<sect2 id="popfilters-dialog"> +<title>The <guilabel>Configure Pop Filter</guilabel> Dialog</title> + +<para>Adding filter rules works similar as for <link +linkend="filters">message filters</link>. On the left hand side you +can manage the existing filters. Use the <guiicon>New</guiicon> +button to add a filter. On the right hand side you can configure +under which conditions the current filter should match. Using <guilabel>Filter +Action</guilabel> you specify what will happen to a message that is +matched by this rule. The available options are:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Download mail</guilabel></term> +<listitem> +<para>Will download the messages matched by the filter, just as any other message +that does not exceed the threshold size.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Download mail later</guilabel></term> +<listitem> +<para>Will tag the messages for later download. This means the messages matched +will stay on the POP server until you choose to download them by +changing the action manually.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Delete mail from server</guilabel></term> +<listitem> +<para>Will delete the message from the server and does not download it. Once you +deleted a message from the server, there is <emphasis>no</emphasis> way you can undo this. +Be careful, as rules could match messages you actually want, too.</para></listitem> +</varlistentry> + +</variablelist> + +<para>The option <guilabel>Always show matched 'Download Later' messages in +confirmation dialog</guilabel> will cause the confirmation dialog to +show up during mailbox check if at least one message was tagged for +<guilabel>Download Later</guilabel> - even if all messages exceeding +the threshold size were matched by a rule. This option is useful in the +case you have messages matched by a rule and tagged for +<guilabel>Download Later</guilabel>, but you do not get any message +exceeding the size limit for a very long time. Without this option, +the confirmation dialog would never show up and you would never have +a chance to get the queued message by changing the action manually.</para> + +</sect2> + +<sect2 id="popfilters-confirmation"> +<title>The Confirmation Dialog</title> + +<para>This dialog shows up whenever you have POP filtering switched +on and messages were found on the server that exceed the threshold +size you defined for the POP account. Now you have the chance to +decide what you want to do with that message. The options are +<guilabel>Download</guilabel> (green), <guilabel>Download +later</guilabel> (yellow with egg watch) and <guilabel>Delete from +server</guilabel> (red <quote>X</quote>). Be cautious with the delete +option, since once you deleted a mail from the server, there is no +way to undelete it again.</para> + +<para>In the <guilabel>Filtered Messages</guilabel> section you can +check the box if you receive messages that were automatically tagged for +a certain action (download, download later, delete) by a filter rule. +The checkbox is only enabled if you receive some messages that were +matched by a filter rule; once you check it, a list similar to the +one for the not-automatically-tagged messages will be displayed and you +can change the action for every single message.</para> + +<para>Please note that if there is a message exceeding the size +limit, but all messages are matched by a filter rule the dialog will +not be displayed. One exception occurs if you have checked +<guilabel>Always show matched 'Download Later' messages</guilabel> in +the <guilabel>Global Options</guilabel> section of the POP filter +configuration dialog; then, the dialog will also be displayed if you only +have matched messages, but at least one message was tagged for +<guilabel>Download later</guilabel>.</para> + +</sect2> + +</sect1> + +<sect1 id="multiple-accounts"> +<title>Using Multiple Accounts</title> + +<para>Multiple accounts are used to check for messages from more than one email address +and/or mail server. Select <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kmail;...</guimenuitem></menuchoice> and click on the +<guilabel>Network</guilabel> page to add or change your account settings. See the +<link linkend="getting-started">Getting started</link> section for more +information on the settings in the <guilabel>Network</guilabel> page.</para> + +<para>To check for messages from a particular account, use the +<menuchoice><guimenu>File</guimenu><guimenuitem>Check Mail +In</guimenuitem></menuchoice> submenu to select the account to check +for mail. You can also press the mouse button on the <guiicon>Check +Mail</guiicon> icon for some time to get a list of accounts.</para> + +</sect1> + +<sect1 id="pgp"> +<!-- This section is from Andreas Gungl, 2000-05-21, updated 2002-10-06 by Ingo Kloecker --> +<title>Signing and Encrypting Messages with <application>PGP</application> +or <application>GnuPG</application></title> + +<note><para>There have been major changes in the way &kmail; handles +signing/encryption. The following introduction applies to the previous +version of &kmail;. You can still read the introduction to get an overview +about how to sign/encrypt messages, but the details, especially those of +the configuration, will differ.</para></note> + +<para>This is a short introduction on how to setup &kmail;'s +<application>PGP</application> (<application>Pretty Good Privacy</application>) support; +it gives some hints on the use of +<application>PGP</application> too. It is written for people who are beginners in +this area; if you are familiar with the use of <application>PGP</application>, you can +skip most of the steps. This documentation, and the &kmail; user interface, +generally talk only about <quote>PGP</quote>, but it applies to +both <application>PGP</application> and <application>GnuPG</application> +(<application>GNU Privacy Guard</application>), +(although some <application>GnuPG</application> command-line parameters +may be different.)</para> + +<para>Please +also check out the <link linkend="pgp-faq">&FAQ; item about +<application>PGP</application></link>.</para> + +<warning><para>Attachments will not be signed/encrypted if you are using +inline OpenPGP: to sign/encrypt attachments, you have to install GnuPG and +some necessary libraries; +then, you can decide for each attachment whether it should be signed/encrypted or not. +</para></warning> + +<warning><para>&kmail; has to rely on <application>PGP</application>'s +output; this output is often different between different versions of +<application>PGP</application>, so it is important that you test if encryption +really works with your setup before you start using it seriously. &kmail; might +<emphasis>not</emphasis> warn you if something fails -- enable +<guilabel>Show signed/encrypted text +after composing</guilabel>. </para></warning> + +<para>To setup and use <application>PGP</application> support in &kmail; it is +necessary to have <application>PGP</application> installed and set up +properly; of course, we cannot give you a full introduction of +<application>PGP</application> here. We will only mention the steps you have to +do to get <application>PGP</application> going. For details you should have a look at +the excellent <application>PGP</application> documentation +or <ulink url="http://www.gnupg.org/docs.html#guides">The GNU Privacy Handbook</ulink>.</para> + +<para>It is certainly a good idea to study this documentation as well as an +introduction into public key cryptography (⪚ out of the +<application>PGP</application> 6.5.x package): there you can learn a lot about +the basic concepts, which will help you to understand what is going on; also, +many security related issues you should know about are discussed there.</para> + +<para>Now, let us start.</para> + +<sect2 id="pgp-preconditions"> +<title>Preconditions</title> + +<para>&kmail; expects that your <application>PGP</application> binary is called +<command>pgp</command>; in the case of <application>GnuPG</application>, it expects +the binary to be called <command>gpg</command>. If this is not the case for you, +just make a symlink.</para> + +<para>If you have not done so, you have to generate a key pair (secret and public +key) for your identity. You must do this at the command line: use +<userinput><command>pgp</command> <option>-kg</option></userinput> +or <userinput><command>gpg</command> <option>--gen-key</option></userinput>: &kmail; +has no internal support for <application>pgp</application>'s key generation at +this time. The identity (normally your name followed by your email address +within brackets, such as <userinput>John Doe +<john@example.com></userinput>) and your passphrase are important for the +co-operation between &kmail; and <application>PGP</application>.</para> + +</sect2> + +<sect2 id="pgp-settings"> +<title><application>PGP</application>-Related Settings in &kmail;</title> + +<para>Select the <guilabel>OpenPGP</guilabel> tab on +the <guilabel>Security</guilabel> settings page; there you will find the +following options:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Encryption tool</guilabel></term> +<listitem> +<para>Here you can choose if you want to use <application>PGP</application>, +<application>GnuPG</application> or no encryption +software at all; of course, the program you select has to be +installed on your system (it is also important to select the correct +version.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Keep passphrase in memory</guilabel></term> +<listitem> +<para>When this option is off, &kmail; will ask for your passphrase each +time you sign a message (before sending) or select an encrypted message; +if you turn this option on, &kmail; will remember your passphrase from +after your first successful input until you finish your &kmail; session. The +passphrase is stored in memory and not written to the hard disk. +If you use one of the Crypto-Plugins or if you use <application>GnuPG</application> +with the gpg-agent then an external program will ask for your passphrase and +optionally remember it for some time.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Always encrypt to self</guilabel></term> +<listitem> +<para>If this option is off and you want to send an encrypted message to somebody, +then you cannot read this message any longer after you have composed and +encrypted it. Turn this option on to keep sent encrypted messages readable for +you too.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show signed/encrypted text after composing</guilabel></term> +<listitem> +<para>This will show you the result of encrypting and signing before the message +gets sent; this way, you can still cancel sending if encrypting failed. It is +strongly recommended to use this option.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Always show the encryption keys for approval</guilabel></term> +<listitem> +<para>This will always open a dialog that lets you choose the keys used for +each recipient when you are sending an encrypted message; if this +option is off, &kmail; will show this dialog only when it cannot +find a key for a recipient or when there are conflicting or unset encryption +preferences.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Automatically sign messages using OpenPGP</guilabel></term> +<listitem><para>This lets you toggle whether to automatically sign your messages +by default; of course, it is still possible to send unsigned messages by deselecting +the icon in the composer window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Automatically encrypt messages whenever possible</guilabel></term> +<listitem><para>If this option is on, &kmail; will automatically encrypt messages +with the built-in OpenPGP support or the PGP/MIME-Plugin provided that, +for every recipient, a trusted PGP key is found in your keyring and +you did not tell &kmail; not to encrypt messages sent to +certain recipients. If in doubt, &kmail; will ask whether the message +should be encrypted or not.</para></listitem> +</varlistentry> + +</variablelist> + +<para>Now that you have setup the encryption tool you have tell &kmail; which +OpenPGP key you want to use for signing and for encrypting messages; +to do this go to the <link linkend="configure-identity">Identities configuration</link> +and set the key that should be used on the <guilabel>Advanced</guilabel> tab of the +identity configuration.</para> + +<para>Now you are able to sign outgoing messages; to let people send you +encrypted messages and to let them verify your signature you +must send them your public key or upload your public key to a public +<application>PGP</application> key server so that they can fetch your key from there. +To send encrypted messages to other people or to verify their signed +messages you will need their public keys; you can store your public key(s) on a +public <application>PGP</application> key server such as <ulink +url="http://www.cam.ac.uk.pgp.net/pgpnet/">http://www.cam.ac.uk.pgp.net/pgpnet/</ulink>.</para> + +</sect2> + +<sect2 id="pgp-sign-your-messages"> +<title>Sign your Messages</title> + +<para>You can compose your message as usual in the composer +window of &kmail;. Before you send the message, check the <guiicon>Sign Message</guiicon> +icon on the toolbar of the composer window; then, you can send +the message. The identity you are using to write the current message needs to +be connected to an <guilabel>OpenPGP Key</guilabel> in the <guilabel>Identity</guilabel> +section of the <guilabel>Configure</guilabel> dialog. +To sign the message, &kmail; needs to know your <application>PGP</application> +passphrase: if you did not select <guilabel>Keep passphrase in memory</guilabel> in the +<guilabel>Security</guilabel> section, &kmail; will ask you for it; otherwise, +if you have already given the phrase to &kmail;, it will sign the +message without any further prompt.</para> + +</sect2> + +<sect2 id="pgp-encrypt-your-messages"> +<title>Encrypt your Messages</title> + +<para>To send an encrypted message to somebody of whom you have a +public key, you simply create the message in the composer window. +Before you send the message, check the <guibutton>Encrypt +Message</guibutton> button in the toolbar of the composer window; note +that you might not have to check the button if <guilabel>Automatically +encrypt messages whenever possible</guilabel> is selected in +&kmail;'s configuration (see <link linkend="pgp-sign-your-messages">above</link>). +Then send the message.</para> + +<para> +If you checked the <guilabel>Encrypt Message</guilabel> button and &kmail; +cannot find a matching key for a recipient, it will display a list containing +all available keys in the <guilabel>Encryption Key Selection</guilabel> dialog; +if &kmail; finds more than one trusted key for a recipient, it will +display a list containing all matching keys for this recipient. In both +cases you can select the key(s) which should be used for encrypting +this message for the recipient in question. +Using the <guilabel>Remember choice</guilabel> +checkbox you can save your selection for future messages.</para> + +<para>If you are using a key for the first time, there are conflicting +Encryption Preferences, or if <guilabel>Always +show the encryption keys for approval</guilabel> is selected in the +<guilabel>Security</guilabel> section of &kmail;'s configuration dialog +the <guilabel>Encryption Key Approval</guilabel> dialog will appear; +here, you can select different keys for the recipients and can +set the <guilabel>Encryption Preference</guilabel> for each recipient. +The default option, <guilabel>Encrypt whenever encryption is +possible</guilabel>, will automatically encrypt your message if there is a +trusted key for each recipient.</para> + +<para>As mentioned above, you will not be able to read your own encrypted sent +messages if you do not check <guilabel>Always encrypt to self</guilabel> in the +settings' <guilabel>Security</guilabel> page.</para> + +</sect2> + +<sect2 id="pgp-send-your-public-key"> +<title>Send your Public Key</title> + +<para>Prepare a message to the person to whom you want to send your public key; +then, choose, in the composer window's menu, +<menuchoice><guimenu>Attach</guimenu><guimenuitem>Attach My Public +Key</guimenuitem></menuchoice>: this will attach the public key you +defined for the current identity to the message. Now you can send the message.</para> + +<para>Remember that it is not safe at all if you sign the message to make sure +that the receiver will get the correct key: there can be a man-in-the-middle +attack, as somebody can change the key and sign the message with that other +key. That is why the recipient should verify the attached key by checking the +key's fingerprint against the one he received in a secure way from you; have a look +at the <application>PGP</application> documentation for further details.</para> + +</sect2> + +<sect2 id="pgp-you-received-an-encrypted-message"> +<title>You received an encrypted Message</title> + +<para>All you have to do is to select the message in &kmail;. You will be +prompted for your passphrase; then, &kmail; will try to decrypt the message and +show you the plain text if the message had been encrypted with your public +key: if not, then you will not be able to read it. &kmail; stores the messages +encrypted, so nobody can read these messages without knowing your passphrase.</para> + +</sect2> + +<sect2 id="pgp-receiving-a-public-key"> +<title>Receiving a Public Key</title> + +<para>You can receive a public key as an attachment or via http, ftp or a floppy. +Before you can use this key to encrypt a message to the owner of the +key, you should verify the key (check its fingerprint or look for +trusted signatures); then, you can add this key to your public keyring +by typing <userinput><command>pgp</command> <option>-ka</option> +<replaceable>filename</replaceable></userinput> at the command line (if you are using +<application>PGP</application>) or by typing +<userinput><command>gpg</command> <option>--import</option> +<replaceable>filename</replaceable></userinput> at the command line (if you are using +<application>GnuPG</application>). If the key is not certified with a trusted signature +you cannot use it to encrypt messages unless you have signed the key with your key. +</para> + +</sect2> + +</sect1> + +<sect1 id="the-anti-spam-wizard"> +<title>The Anti-Spam Wizard</title> + +<sect2 id="spam-wizard-basics"> +<title>Basics</title> + +<para>&kmail; does not have a built-in spam detection solution: the developers believe +using external, but specialized, tools is the better approach. &kmail; uses these tools +through its flexible filter architecture. The Anti-Spam Wizard helps you with the +initial filter setup. +</para> + +<variablelist> +<varlistentry> +<term>What can the wizard do to help you?</term> +<listitem> +<para>It will give you some choices about how you want the spam filtering to be set up. +Afterwards it will automatically create the appropriate filter rules. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>What are the limitations of the wizard?</term> +<listitem> +<para>It can only initially set up the filters for you; and it will provide a +standard setup. Manual modifications in existing filters are not considered. +Instead, these filters are overwritten by the wizard. +</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You can activate the wizard via <menuchoice><guimenu>Tools</guimenu> +<guisubmenu>Anti-Spam Wizard...</guisubmenu></menuchoice>.</para> + +<para>The wizard scans for known anti-spam tools on your computer. +It is as well possible to use results of spam checks made by your provider +by evaluating some header information which has been added to the messages. +You can let the wizard prepare &kmail; to use one or many of them in parallel. +However, note that anti-spam tool operations are usually time consuming. +&kmail; can appear to be frozen during the scan of the messages for spam, +you may encounter problems with the responsiveness of &kmail;. Please consider +deleting the filter rules created by the wizard if the filtering becomes +too slow for you. +Here are some recommendations regarding the supported tools:</para> + +<variablelist> +<varlistentry> + <term>Bogofilter</term> +<listitem> +<para>Bogofilter is a bayesian filter, that means it's spam detection +relies on an initial training phase. On the other hand, it's a pretty +fast tool. That's why it is recommended to be used by people which +primarily want to have a fast spam detection, and which don't worry +about the little training in the beginning before the detection rate +increases significantly. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>SpamAssassin</term> +<listitem> +<para>SpamAssassin is a pretty complex tool to fight against spam. +Although it's behavior depends heavily on it's configuration, that +tool can detect spam quite well without any training. However, +scanning a message takes a little longer compared to pure bayesian +filters. Let's say, it's not the tool of choice for people without +some background information about SpamAssassin's capabilities. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>Annoyance-Filter</term> +<listitem> +<para>Perhaps not so often used until distributions pick it up. +It's clearly a tool for specialists. +</para> +</listitem> +</varlistentry> +<varlistentry> + <term>GMX Spam Filter</term> +<listitem> +<para>Given that you get your mail via the GMX freemail provider, +your messages are scanned for spam. The result of that process is +documented in a special header field of each message. It's possible to +use the content of this header field to sort out spam. There is no +slowdown in the filtering if only this tool is used, as the messages +have already been processed. +</para> +</listitem> +</varlistentry> +</variablelist> + + +</sect2> + +<sect2 id="spam-wizard-advanced"> +<title>Advanced</title> + +<para>Here are the details of how the wizard works: &kmail; can use several +external tools to detect spam messages; it will try to automatically find +out which of those tools are installed on your box and will show you these +tools in a list. The list is ordered by the average speed of the filtering +process of the tools. You can mark the tools which you want +to be used by &kmail; to detect spam. Of course, you +can close the wizard, install a tool, and restart the wizard again. +</para> + +<para>If you have marked at least one tool, KMail is able to provide filters +which allow the classification of the messages as spam or not spam. It will +also provide actions to let you manually classify messages. These actions will +be available via the menu and via toolbar icons. +If any of the tools you selected support Bayesian filtering (&ie; a method +to detect spam based on statistical analysis of the messages) then these +messages are not only marked but additionally transfered to the tools to +let them learn so they can improve their detection rate. +</para> + +<para>On the second page, there you will be able to select some additional +actions to be done in &kmail; with regard to spam messages: if you +want messages detected as spam to be moved into a certain folder, please select +the appropriate folder and mark the <guilabel>Move known spam to:</guilabel> +option; if messages detected as spam should additionally be marked as read, +then mark the <guilabel>Mark detected spam messages as read</guilabel> option. +</para> + +<para>Having checked at least one of the available tools will allow you to +let the wizard finish the filter setup. The wizard will not take any +modifications in existing filters formerly created by the wizard into +consideration but will either append new filters or replace existing filters +in any case; you may want to inspect the result of this process in the +<link linkend="filter-dialog">Filter Dialog</link>. +The wizard will also create toolbar buttons for marking messages as spam or +as ham; keep in mind that classifying messages as spam will also move those +messages to the folder you had specified for spam messages, if you haven't +deselected the appropriate option. +</para> + +</sect2> + +<sect2 id="spam-wizard-details"> +<title>Some More Details for Experts</title> + +<para>The wizard uses information stored in a special configuration file named +<filename>kmail.antispamrc</filename> (stored in the global or local KDE +config directory). It will first check the global config file and then the local +config file: if the local config file contains entries with higher (newer) +version numbers per-tool the configuration data from the local file for that +tool is used; that way, both administrators and users can update the +wizard configuration. +</para> + +<para>The local detection of spam messages is achieved by creating +<guilabel>pipe through</guilabel> actions per-tool within a +special filter. Another filter contains rules to check for detected spam +messages and actions to mark them and (optionally, depending on the choice +in the wizard) to move them into a folder. Both filters are configured to +be applied on incoming messages and on manual filtering. +</para> + +<para>Two filters are needed for the classification of ham and spam. They +contain actions to mark the messages appropriately. As mentioned above, the filter +for classification as spam can have another action to move the message into a +predefined folder. If the selected tools support Bayesian filtering, +the wizard will create additional filter actions to pass the messages to the +tools (via <guilabel>execute command</guilabel> actions) in the +appropriate learn mode. +</para> + +<para>If you want to fine-tune the filtering process, you might be interested in the +chapter about <link linkend="filter-optimization">Filter Optimization</link>.</para> + +</sect2> + +</sect1> + +<sect1 id="the-anti-virus-wizard"> +<title>The Anti-Virus Wizard</title> + +<sect2 id="virus-wizard-basics"> +<title>Basics</title> + +<para>&kmail; does not have a built-in virus detection solution: the developers believe +using external, but specialized, tools is the better approach. &kmail; uses these tools +through its flexible filter architecture. The Anti-Virus Wizard helps you with the +initial filter setup. +</para> + +<variablelist> +<varlistentry> +<term>What can the wizard do to help you?</term> +<listitem> +<para>It will give you some choices about how you want virus filtering to be set up. +Afterwards it will automatically create the appropriate filter rules. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>What are the limitations of the wizard?</term> +<listitem> +<para>It can only initially set up the filters for you; and it will provide a +standard setup. Modifying existing filters is not yet possible. +</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You can activate the wizard via <menuchoice><guimenu>Tools</guimenu> +<guisubmenu>Anti-Virus Wizard...</guisubmenu></menuchoice>.</para> + +</sect2> + +<sect2 id="virus-wizard-advanced"> +<title>Advanced</title> + +<para>The Anti-Virus Wizard basically works exactly as the +<link linkend="the-anti-spam-wizard">Anti-Spam Wizard</link>. +Here are the details of how the wizard works: &kmail; can use several +external tools to detect messages containing viruses; it will try to automatically find +out which of those tools are installed on your box and will show you the +result of the search for each tool. You can mark the tools which you want +to be used by &kmail; to detect viruses; marking tools which were not found is +not possible because the appropriate checkboxes are disabled. Of course, you +can close the wizard, install a tool, and restart the wizard again. +</para> + +<para>If you have marked at least one tool you will be able to select some actions +to be done in &kmail; with regard to messages containing viruses: to let &kmail; detect +messages containing viruses you definitely should mark the <guilabel>Check messages using the +anti-virus tools</guilabel> option; if you want messages detected as +virus-infected to be moved into a certain folder, please select the appropriate folder and +mark the <guilabel>Move detected viral messages to the selected folder</guilabel> +option; if messages detected as virus-infected should additionally be marked as read, +then mark the <guilabel>Additionally, mark detected viral messages as read</guilabel> option. +</para> + +<para>Having checked at least one of these last options will allow you to +let the wizard finish the filter setup. The wizard will not take any existing +filter rules into consideration but will append new rules in any case; you +may want to inspect the result of this process in the +<link linkend="filter-dialog">Filter Dialog</link>. +</para> + +</sect2> + +<sect2 id="virus-wizard-details"> +<title>Details</title> + +<para>The wizard uses information stored in a special configuration file named +<filename>kmail.antivirusrc</filename> (stored in the global or local KDE +config directory). It will first check the global config file and then the local +config file: if the local config file contains entries with higher (newer) +version numbers per-tool the configuration data from the local file for that +tool is used; that way, both administrators and users can update the +wizard configuration. +</para> + +<para>The detection of messages containing viruses is achieved by creating +<guilabel>pipe through</guilabel> actions per-tool within a +special filter. Another filter contains rules to check for detected viral +messages and actions to mark them and (optionally, depending on the choice +in the wizard) to move them into a folder. Both filters are configured to +be applied on incoming messages and on manual filtering. +</para> + +</sect2> + +</sect1> + +</chapter> |