diff options
Diffstat (limited to 'doc/kmail')
| -rw-r--r-- | doc/kmail/configure.docbook | 205 | ||||
| -rw-r--r-- | doc/kmail/index.docbook | 2 | ||||
| -rw-r--r-- | doc/kmail/using-chiasmus.docbook | 158 | ||||
| -rw-r--r-- | doc/kmail/using-kmail.docbook | 23 |
4 files changed, 359 insertions, 29 deletions
diff --git a/doc/kmail/configure.docbook b/doc/kmail/configure.docbook index a66665ad3..7643b3562 100644 --- a/doc/kmail/configure.docbook +++ b/doc/kmail/configure.docbook @@ -648,7 +648,7 @@ so you can choose a monospaced font for the date field for better readability.</ 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, +(space allotment, 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> @@ -657,6 +657,11 @@ can be configured along with the other custom colors.<!-- TODO --></para> <sect2 id="configure-appearance-layout"> <title>Layout</title> +<para>If the <guilabel>Close message window after replying or forwarding</guilabel> option is +activated, KMail will close the message window after replying to or forwarding the message that +is displayed in the window. This only applies to the separate message window, not to the embedded +message preview pane.</para> + <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 @@ -777,6 +782,32 @@ folder will be selected in &kmail;'s main window. </para> </listitem> </varlistentry> + <varlistentry id="configure-composer-general-quote-selection-only"> + <term> + <guilabel>Only quote selected text when repyling</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will quote only the selected text in the message window, + instead of the complete message, when replying. + With this, it is possible to quickly generate replies that quote only the relevant + paragraph to which you are actually replying, and omits the other paragraphs that are + not relevant to the context. + </para> + </listitem> + </varlistentry> + <varlistentry id="configure-composer-general-strip-signatures"> + <term> + <guilabel>Remove the signature when replying</guilabel> + </term> + <listitem> + <para> + If checked, &kmail; will remove the signature from the quoted text + when replying to a message. This is useful since it reduces the amount + of quoted text, which makes it easier to read the reply. + </para> + </listitem> + </varlistentry> <varlistentry id="configure-composer-general-auto-request-mdns"> <term> <guilabel>Automatically request message disposition notifications</guilabel> @@ -806,6 +837,19 @@ folder will be selected in &kmail;'s main window. </para> </listitem> </varlistentry> + <varlistentry id="configure-composer-general-too-many-recipients"> + <term> + <guilabel>Warn if the number of recipients is larger than</guilabel> + </term> + <listitem> + <para> + If the number of recipients is larger than this value, KMail will + warn and ask for a confirmation before sending the mail. + The default is to warn if there are more than <literal>5</literal> recipients. + This warning can be turned off. + </para> + </listitem> + </varlistentry> <varlistentry id="configure-composer-general-autosave-interval"> <term> <guilabel>Autosave interval</guilabel> @@ -819,6 +863,18 @@ folder will be selected in &kmail;'s main window. </para> </listitem> </varlistentry> + <varlistentry id="configure-composer-general-forwading-type"> + <term> + <guilabel>Default Forwarding Type</guilabel> + </term> + <listitem> + <para> + Lets you decide whether you want to forward messages inline or as an attachment by default. + This changes which type of forwarding mechanism is used when you click the toolbar icon or + when you activate the shortcut for forwarding. + </para> + </listitem> + </varlistentry> <varlistentry id="configure-composer-general-external-editor"> <term> <guilabel>External Editor</guilabel> @@ -1102,7 +1158,7 @@ of key words can be modified.</para> <para> Attaches the complete message to the disposition notification. Usually, this is overkill. It does - not add any valueable information that cannot be + not add any valuable 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 @@ -1276,7 +1332,7 @@ of key words can be modified.</para> </term> <listitem> <para> - If checked, everytime you encrypt a message, a dialog + If checked, every time 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 @@ -1335,7 +1391,7 @@ of key words can be modified.</para> </title> <para> - On this tab you can switch security-relavant warnings on and + On this tab you can switch security-relevant warnings on and off. </para> @@ -1386,7 +1442,7 @@ of key words can be modified.</para> <listitem> <para> If checked, &kmail; will emit a warning if an &smime; - certifciate or &openpgp; key will be used for a recipient + certificate or &openpgp; key will be used for a recipient whose email address is not listed in the email addresses stored in the certificate. </para> @@ -1698,7 +1754,7 @@ of key words can be modified.</para> 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 + listed, but grayed 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 @@ -1793,12 +1849,39 @@ Correspondingly, if you ask &kmail; to go to the previous unread message. </varlistentry> <varlistentry> -<term><guilabel>Jump to first unread message when entering a folder</guilabel></term> + +<term><guilabel>When entering a folder</guilabel></term> +<listitem> +<para>This option controls what happens if you open a folder. +<itemizedlist> +<listitem> +<para>If <guilabel>Jump to First New Message</guilabel> is selected then &kmail; will select the +first message it finds that is marked as new. +</para> +</listitem> +<listitem> +<para>If <guilabel>Jump to First Unread or New Message</guilabel> is selected then &kmail; will +select the first message it finds that is marked either as new or as unread. +</para> +</listitem> +<listitem> +<para>If <guilabel>Jump to Last Selected Message</guilabel> is selected then &kmail; will select +the message that was selected when the folder was open the last time. +</para> +</listitem> +<listitem> +<para>If <guilabel>Jump to Newest Message</guilabel> is selected then &kmail; will select the newest +message by date. +</para> +</listitem> <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> +<para>If <guilabel>Jump to Oldest Message</guilabel> is selected then &kmail; will select the oldest +message by date. +</para> +</listitem> +</itemizedlist> + +</para> </listitem> </varlistentry> @@ -1908,6 +1991,21 @@ option is selected.</para> <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> +<varlistentry> +<term><guilabel>Exchange compatible invitations naming</guilabel></term> +<listitem> +<para>Microsoft Outlook, when used in combination with a Microsoft Exchange +server, has a problem understanding standards-compliant groupware e-mail. +Enable this option to send groupware invitations in a way that Microsoft +Exchange understands. The invitation will be sent as an attachment with name <filename>ical.ics</filename>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Outlook compatible invitation reply comments</guilabel></term> +<listitem> +<para>When the user provides comments when responding to invitations, send the comment in way that Microsoft Outlook(tm) understands. If this option is not enabled, the response comments will not be seen in Outlook.</para> +</listitem> +</varlistentry> </variablelist> </sect2> @@ -1934,7 +2032,7 @@ 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 +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> @@ -1956,20 +2054,6 @@ The option is enabled by default. To disable the feature, add a line reading (un </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> @@ -2011,6 +2095,73 @@ To disable the feature, add a line reading (under [OutOfOffice] section): </listitem> </varlistentry> +<varlistentry> +<term><guilabel>Allow out-of-office settings to be adjusted by the user.</guilabel></term> +<listitem> +<para> +In case you don't want users to be able to upload their own out-of-office scripts to +the server you can add: +</para> +<programlisting>AllowOutOfOfficeSettings=false +</programlisting><para> +to the [OutOfOffice] section of the kmail configuration file. If there is no such section, simply add "[OutOfOffice]" on +a line by itself just above the option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow out-of-office scripts to be uploaded by the user, but no settings changed.</guilabel></term> +<listitem> +<para> +If you want to allow your users to upload their own out-of-office scripts but you do not want them to be +able to change the domain to react to and the react-to-spam setting, you can add: +</para> +<programlisting>AllowOutOfOfficeUploadButNoSettings=true +</programlisting><para> +to the [OutOfOffice] section of the kmail configuration file. If there is no such section, simply add "[OutOfOffice]" on +a line by itself just above the option. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guilabel>Default domain to limit out-of-office replies to.</guilabel></term> +<listitem> +<para> +When editing vacation (out-of-office) scripts, the user can specify a domain to +limit the sending of such replies to. To pre-load this setting with a default +value, add +</para> +<programlisting>OutOfOfficeDomain=myMailDomain.test +</programlisting><para> +to the [OutOfOffice] section of the kmail configuration file. If there is no such section, simply add "[OutOfOffice]" on +a line by itself just above the option. + +Applying defaults to the out-of-office configuration dialog via the corresponding +button will restore this domain, in case the user has changed it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable sending of out-of-office replies to messages marked as SPAM.</guilabel></term> +<listitem> +<para> +By default, out-of-office replies are not sent to messages marked as SPAM. To override this +behavior, add +</para> +<programlisting>OutOfOfficeReactToSpam=true +</programlisting><para> +to the [OutOfOffice] section of the kmail configuration file. If there is no such section, simply add "[OutOfOffice]" on +a line by itself just above the option. + +Applying defaults to the out-of-office configuration dialog via the corresponding +button will restore this setting, in case the user has changed it. +</para> +</listitem> +</varlistentry> <varlistentry> <term><guilabel>disregardUmask</guilabel></term> @@ -2030,7 +2181,7 @@ To enable the feature, add a line reading (under [General] section): <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. +this option is enabled, you will be ask how to proceed every time otherwise. To enable the feature, add a line reading: </para> diff --git a/doc/kmail/index.docbook b/doc/kmail/index.docbook index fe38a5100..06faeb065 100644 --- a/doc/kmail/index.docbook +++ b/doc/kmail/index.docbook @@ -9,6 +9,7 @@ <!ENTITY kmail-menus SYSTEM "menus.docbook"> <!ENTITY kmail-faq SYSTEM "faq.docbook"> <!ENTITY kmail-importing SYSTEM "importing.docbook"> + <!ENTITY kmail-chiasmus SYSTEM "using-chiasmus.docbook"> <!ENTITY kmail-credits-and-licenses SYSTEM "credits-and-licenses.docbook"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE" > <!-- change language only here --> @@ -126,6 +127,7 @@ &kmail-menus; &kmail-faq; &kmail-importing; +&kmail-chiasmus; &kmail-credits-and-licenses; <appendix id="installation"> diff --git a/doc/kmail/using-chiasmus.docbook b/doc/kmail/using-chiasmus.docbook new file mode 100644 index 000000000..cd075d868 --- /dev/null +++ b/doc/kmail/using-chiasmus.docbook @@ -0,0 +1,158 @@ +<chapter id="chiasmus"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Jan-Oliver</firstname> +<surname>Wagner</surname> +<affiliation><address> +<email>jan@intevation.de</email> +</address></affiliation> +</author> +<author> +<firstname>Till</firstname> +<surname>Adam</surname> +<affiliation><address> +<email>till@kdab.net</email> +</address></affiliation> +</author> + +</authorgroup> + +<date>2005-06-30</date> +<releaseinfo>1.8</releaseinfo> +</chapterinfo> + +<title>Using the Chiasmus encryption tool</title> + +<sect1 id="chiasmus-preparations"> +<title>Preparations</title> + +<para> +To encrypt and decrypt with Chiasmus, you need the BSI's Chiasmus +command line tool for GNU/Linux. It is intended solely for use in +government agencies and availabe from the BSI on request. +</para> + +<para> +When executed without parameters, the <command>chiasmus</command> +program should output something like: +</para> + +<para> +<screen> +Chiasmus (R) fuer Windows K 1.8.0.0 +Bundesamt fuer Sicherheit in der Informationstechnik +Kontakt: Chiasmus@bsi.bund.de +(C) 2001 - 2005 +[ ...] +</screen> +</para> + +<para> +Version 1.8.0.0 was tested succesfully. Other versions may or may not +work correctly. +</para> + +<para> +As a last preparation step a directory which will hold the key files +ending in <filename>.xis</filename> has to be created, if none already exists. Usually +<filename class="directory">~/.chiasmus/</filename> is used. +</para> + +</sect1> + +<sect1 id="chiasmus-configuration"> + <title>Configuration</title> +<para> +Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KMail +</guimenuitem></menuchoice> and choose the <guilabel>Crypto-Backends</guilabel> +tab on the Security page. Select the entry for <guilabel>Chiasmus</guilabel> and click +<guibutton>Configure....</guibutton> to open the configuration dialog +for the Chiasmus backend. +</para> + +<para> +Specify the path to the Chiasmus binary and the directory where key files are +to be stored, using the file selection dialogs which open when you click the +folder icons next to the path entries. +</para> + +<para> +Close the backend configuration dialog by clicking <guibutton>Ok</guibutton> +and check the <guilabel>Chiasmus Checkbox</guilabel> to activate it. Then also close the main +configuration dialog. +</para> + +</sect1> + + +<sect1 id="chiasmus-encryption"> + <title>Encryption</title> +<para> +To encrypt a message with Chiasmus, select <menuchoice><guimenu> +Options</guimenu><guimenuitem>Encrypt message with chiasmus +</guimenuitem></menuchoice>. A dialog comes up in which you can select +the key file to use, as well as additional command line arguments to +be passed to <command>chiasmus</command>. +</para> + +<note> +<para> +If you want to use Chiasmus encryption regularly, you should add +an icon for that option to your toolbar, using <menuchoice><guimenu> +Settings</guimenu><guimenuitem>Configure toolbars</guimenuitem> +</menuchoice>. Move the entry for <guilabel>Encrypt with Chiasmus +</guilabel> from the left side of the dialog to the right, using the +buttons between the two panes. You can then quickly enable or disable +Chiasmus encryption using that toolbar button and have a visual +indication of the current state. +</para> +</note> + +<note> +<para> +If automatic saving of backup copies of currently edited messages is +enabled, you will be prompted for your Chiasmus password, if Chiamsus +encryption is active. +</para> +</note> + +<para> +On message sending, you will be prompted for the password. If the password +is correct, the text of the message and all its attachments will be +encrypted. +</para> + +<note> +<para> +The other signing and encryption options are completely independent of +the Chiasmus encryption. You can use those in addition to Chiasmus, +⪚ to sign the message. Additional encryption, on the other hand, +does not make much sense and complicates decryption for the +recipients. +</para> +</note> + +</sect1> + +<sect1 id="chiasmus-decryption"> + <title>Decryption</title> +<para> +&kmail; and &kontact; detect messages that have been encrypted +using Chiasmus and will automatically ask for the key file to use for +decryption, as well as the corresponding password. If the password is correct, the +message will be decrypted and displayed. +</para> + +<para> +To decrypt attachments that were encrypted using Chiasmus (&ie; those which have +a file name ending in <filename>.xia</filename>), right-click on the +attachment you want to decrypt and select <menuchoice><guimenuitem>Decrypt using Chiasmus +</guimenuitem></menuchoice>. After you have chosen a key file to be used for decryption and +entered the correct password for it, a file selection dialog will allow you +to specify where the decrypted attachment should be saved. +</para> +</sect1> + +</chapter> diff --git a/doc/kmail/using-kmail.docbook b/doc/kmail/using-kmail.docbook index 1d3b3e381..6bc1046fa 100644 --- a/doc/kmail/using-kmail.docbook +++ b/doc/kmail/using-kmail.docbook @@ -375,6 +375,25 @@ checker. Note that you may first need to configure the spellchecker using </sect2> +<sect2 id="setup-text-snippets"> +<title>Setting Up the Text Snippets Tool</title> +<para> +When editing in the composer window you can store often used parts of text as snippets. To configure the capabilities of the mail snippets part select <menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Snippets</guimenuitem> </menuchoice> from the menubar. A new panel will appear on the left side of the composer. +</para> +<para>To add a new snippet to Snippet Panel, right click on panel, click on <menuchoice><guimenu>Add Snippet</guimenu></menuchoice> in the context menu. A snippet editor dialog will appear, in which new text can be added and the snippet can be given a name. Also a <guilabel>Shortcut</guilabel> can be associated with the snippet. +Snippets can be grouped together as well by creating groups and adding snippets to particular group. If you want to view the stored text in a tooltip window whenever you keep the mouse cursor over the title of that snippet. +</para> +<para>The <guilabel>Snippets</guilabel> tool allows for a variable text in predefined places any time you insert a snippet into a file. To accomplish this <guilabel>Snippets</guilabel> provides its own variables' mechanism. You can set up its behaviour in the snippet text itself by using separators ( $ ) that enclose the variable names. For example : $variablename$, $invoicenumber$, $weekno$. +</para> +<para> +The variable separator can be changed to some other character by changing "snippetDelimiter" in [SnippetPart] section. The Text Snippet configuration file can be found here $KDEHOME/share/config/kmailsnippetrc . +<programlisting> +snippetDelimiter=$ +</programlisting> + +</para> + +</sect2> </sect1> <sect1 id="folders"> @@ -503,7 +522,7 @@ events by using the <guilabel>Generate free/busy and activate alarms for</guilab 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> +you can block them locally by activating the <guilabel>Block alarms locally</guilabel> checkbox.</para> </sect3> @@ -1321,7 +1340,7 @@ which you do not like.</para> </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><para>This will forward the message inline (&ie; as if you selected <menuchoice><guimenu>Message</guimenu><guimenuitem>Forward</guimenuitem><guimenuitem>Inline...</guimenuitem></menuchoice>) to another email address. You can select the template to be used when forwarding with this filter with the drop down list.</para> </listitem> </varlistentry> <varlistentry> |