diff options
authorBurkhard Lück <[email protected]>2017-07-05 12:18:20 +0200
committerBurkhard Lück <[email protected]>2017-07-05 12:18:36 +0200
commit8a810ad7cad6f5dbf025867a6364bb25fb5e3397 (patch)
parente2cc716a7080f22019cf259f1c25d8af2f22cac6 (diff)
update kmail documentation (getting-started.docbook)
remove reference to appendix installation, unused in kf5 update getting-started.docbook and remove obsolete infos Differential Revision:
1 files changed, 29 insertions, 67 deletions
diff --git a/doc/kmail2/getting-started.docbook b/doc/kmail2/getting-started.docbook
index 15ed442..8f6cb9c 100644
--- a/doc/kmail2/getting-started.docbook
+++ b/doc/kmail2/getting-started.docbook
@@ -33,8 +33,8 @@
-<releaseinfo>&kde; 4.12</releaseinfo>
+<releaseinfo>Applications 17.08</releaseinfo>
@@ -64,16 +64,24 @@ start working with it right away. For more in-depth information see the
<para>The first time you run &kmail; you will be greeted with the Account Wizard.</para>
<note><para>If at anytime you need to run the account wizard again, you can find it under
-<menuchoice><guimenu>Tools</guimenu><guimenuitem>Account Wizard</guimenuitem></menuchoice>.</para></note>
+<menuchoice><guimenu>Settings</guimenu><guimenuitem>Add Account</guimenuitem></menuchoice>.</para></note>
<para>The wizard will take you through the process of creating your email accounts. Your screens will vary depending
on how much the wizard can determine on its own. Below is an outline of the screens you may encounter while using this wizard.</para>
- <para><guilabel>Provide personal data</guilabel> is the first screen of the wizard. It will prompt you for your basic account information: <guilabel>Full name:</guilabel>, <guilabel>E-mail address</guilabel>, and <guilabel>Password:</guilabel>.
+ <para><guilabel>Provide personal data</guilabel> is the first screen of the wizard. It will prompt you for your basic account information: <guilabel>Full name:</guilabel>, <guilabel>E-mail address</guilabel>, and <guilabel>Password</guilabel>.
By default, the <guilabel>Find provider settings on the Internet</guilabel> option is checked, the wizard will attempt to retrieve the necessary
information from the server. Uncheck this option if you are an expert user and you need to set up advanced configuration. Click the <guibutton>Next</guibutton> button once finished.
<note><para>If you use GMail 2-step verification you will need to generate an application-specific password within gmail security settings and enter that password
- in the password text box.</para></note>
+ in the password text box.</para></note><!--FIXME verify this-->
+ </para>
+ </listitem>
+ <listitem>
+ <para>If you want to secure your communication with GnuPG you can generate a new key and publish the key on a public key server
+ or import an existing key.
+ </para>
+ <para>When sending mails &kmail; then automatically looks for encryption keys of your recipients and secures the mail when keys for each recipient can be found.
+ It also signs your mails cryptographically so that it can be verified that your messages have not been tampered with.
@@ -82,9 +90,9 @@ start working with it right away. For more in-depth information see the
Once your account type has been selected, click the <guibutton>Next</guibutton> button, and you will be presented with the <guilabel>Personal Settings</guilabel> screen.
<para>The <guilabel>Provide personal data</guilabel> screen will show again with the server details it found if the wizard was successful at determining the account type.
- Click the <guibutton>Create Account</guibutton> button, and it will set up the account. Click the <guibutton>Finish</guibutton> to complete the wizard and close the window.
+ Click the <guibutton>Finish</guibutton> set up the account, complete the wizard and close the window.
+ <!--FIXME Maildir + MailBox URL: but no input field on the next screen?-->
<para>The <guilabel>Personal Settings</guilabel> screen will show if you had to enter your account type.
@@ -105,8 +113,8 @@ start working with it right away. For more in-depth information see the
<para>The Configure window consists of six sections:
<guilabel>Identities</guilabel>, <guilabel>Accounts</guilabel>,
<guilabel>Appearance</guilabel>, <guilabel>Composer</guilabel>,
-<guilabel>Security</guilabel>, and
+<guilabel>Security</guilabel>, <guilabel>Misc</guilabel>, and
<para>To begin sending and receiving messages you will only have to
change some settings in the <guilabel>Identities</guilabel> and
@@ -136,6 +144,7 @@ change some settings in the <guilabel>Identities</guilabel> and
+ <!--FIXME Advanced Templates Picture tabs-->
Optionally, go to the <guilabel>Signature</guilabel> tab and
enter your signature. This is a short text that will be
@@ -162,13 +171,7 @@ administrator.</para>
<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>
+button you can fill in the <guilabel>Name</guilabel>
field with a descriptive name
(&eg; <userinput>My Mail Account</userinput>). Click the <guibutton>Create and Configure</guibutton>
and fill the <guilabel>Outgoing mail server</guilabel>
@@ -177,12 +180,6 @@ field with the name and domain of your mail server
not need to change the <guilabel>Port</guilabel> setting (the default is
-<!-- 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>
<para>The way of sending messages configured here will be used for
your default identity and for all other identities that do not have their own
way of sending messages. You can use different ways of sending
@@ -204,16 +201,20 @@ chapter.</para>
<sect2 id="receiving-mail">
<title>Receiving Messages</title>
-<!-- review - changed to akonadi ressources? lueck 31.05.2011-->
+<para>By default the <guilabel>Local Folders</guilabel> (inbox, outgoing, sentmail,
+trash, drafts and templates) with data from a local Maildir folder are predefined on this tab.
+Using the drop down box you can select the <guilabel>Retrieval Options</guilabel> for these folders.</para>
<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 E-Mail Server</guilabel>. If
+select <guilabel>POP3 E-Mail Server</guilabel> or <guilabel>IMAP E-Mail Server</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>Akonadi Resource</guilabel> window. First, fill in the
+the account settings window. First, fill in the
<guilabel>Account name</guilabel> field to name your account. You can choose any name
you like. <guilabel>Username</guilabel>, <guilabel>Password</guilabel>, and
<guilabel>Incoming mail server</guilabel> should be filled in with the appropriate information
@@ -222,38 +223,8 @@ need to change the <guilabel>Port</guilabel> setting (the default for POP3 is
<userinput>110</userinput>, the default for <acronym>IMAP</acronym> is
-<sect3 id="receiving-mail-kolab"><!-- review - still relevant? remove? lueck 31.05.2011-->
-<title>Options relevant to <acronym>Kolab</acronym> server</title>
-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 Supports</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. These settings may of course be configured manually.</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.
-<sect3 id="receiving-mail-dimap-misc"><!-- review - still relevant? remove? lueck 31.05.2011-->
-<title>Options only relevant to DIMAP (<acronym>Kolab</acronym> server)</title>
-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>.
-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.
<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
@@ -300,17 +271,6 @@ server. You should carefully test this to make sure it works safely.</para>
<sect3 id="receiving-mail-imap-pop3">
<title>Options for both <acronym>IMAP</acronym> and POP3</title>
-<!-- removed in 4.8
-<para>If you select <guilabel>Store POP password</guilabel> or
-<guilabel>Store IMAP Password</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 (&eg; system
-administrators) can easily get your password if you select this
<para>&kmail; supports encryption via <guilabel>SSL/TLS</guilabel> and
<guilabel>STARTTLS</guilabel> (<guilabel>SSL/TLS</guilabel> should be preferred
if it is available).</para>
@@ -323,7 +283,9 @@ if it is available).</para>
<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>DIGEST-MD5</guilabel> (recommended),</para></listitem>
+<listitem><para><guilabel>GSSAPINTLM</guilabel> and </para></listitem>
<listitem><para><guilabel>APOP</guilabel> authentication.</para></listitem>