diff --git a/doc/kmail2/accountwizard.png b/doc/kmail2/accountwizard.png index 46ce4233f..70c9b9568 100644 Binary files a/doc/kmail2/accountwizard.png and b/doc/kmail2/accountwizard.png differ diff --git a/doc/kmail2/accountwizard2.png b/doc/kmail2/accountwizard2.png new file mode 100644 index 000000000..7aff3280a Binary files /dev/null and b/doc/kmail2/accountwizard2.png differ diff --git a/doc/kmail2/accountwizard3.png b/doc/kmail2/accountwizard3.png new file mode 100644 index 000000000..7d2243858 Binary files /dev/null and b/doc/kmail2/accountwizard3.png differ diff --git a/doc/kmail2/accountwizard4.png b/doc/kmail2/accountwizard4.png new file mode 100644 index 000000000..80230e648 Binary files /dev/null and b/doc/kmail2/accountwizard4.png differ diff --git a/doc/kmail2/configure.png b/doc/kmail2/configure.png index e3204362d..df96426fa 100644 Binary files a/doc/kmail2/configure.png and b/doc/kmail2/configure.png differ diff --git a/doc/kmail2/getting-started.docbook b/doc/kmail2/getting-started.docbook index 1d2c0c61a..e787963f3 100644 --- a/doc/kmail2/getting-started.docbook +++ b/doc/kmail2/getting-started.docbook @@ -19,12 +19,16 @@ &Scarlett.Clark; &Scarlett.Clark.mail; + +&David.Bryant; +&David.Bryant.mail; + -2017-04-18 -Applications 17.08 +2020-08-18 +KDE 5.14.2 (20.04.2) @@ -37,93 +41,214 @@ start working with it right away. For more in-depth information see the Account Wizard - -Account Wizard - - - - - - Account Wizard - - - Account Wizard - - - - -The first time you run &kmail; you will be greeted with the Account Wizard. -If at anytime you need to run the account wizard again, you can find it under +The first time you run &kmail; you will be greeted by the Account Wizard. +If at any time you need to run the account wizard again, you can find it under SettingsAdd Account. -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. - - - Provide personal data is the first screen of the wizard. It will prompt you for your basic account information: Full name:, E-mail address, and Password. - By default, the Find provider settings on the Internet 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 Next button once finished. - 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. +The wizard will lead you through the process of creating an email account. Your screens will vary depending + on how much the wizard can determine on its own. Here is an outline of the screens you will encounter while using this wizard. +  + + + + The first screen of the wizard is Provide personal data. It will prompt you for your basic account information: Full name:, E-mail address, and Password. + By default, the Find provider settings on the Internet option is checked, so the wizard will attempt to retrieve the necessary + information from the email server. Uncheck this option if you are an expert user and you want to set up advanced configuration. Click the + Next button when finished. + + + Account Wizard + + + + + + Account Wizard + + + The "Provide personal data" dialogue + + + + + GMail accounts must use &IMAP;. If you have enabled 2-step verification for your GMail account, you will have to get a + verification code from Google as part of the initial account setup process. You will not have to perform 2-factor verification + after the &kmail; account has been created, because Google marks your &IMAP; link as fully trusted. + +   + + + + The next screen helps you set up encryption keys for your mail. + + + Account Wizard 2 + + + + + + Account Wizard 2 + + + The encryption options dialogue + + + + + If you want to secure your communications with GnuPG you can generate a new key and publish the key on a public key server, + or you can import an existing key. If you decide to generate a new key pair, do not forget the password used to generate it. You will + need that password every time you want to use the key. - - - 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. + When sending mail, &kmail; optionally looks for encryption keys for your recipients, and encrypts the message if a key can be found. + &kmail; can also sign your mail cryptographically, so that each recipient can verify that your message has not been tampered with. - 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. +   + + + + A Setup complete screen will appear if the wizard determined the account type successfully. + Click Details... to view the settings &kmail; has established. Click the Finish + button to set up the account, complete the wizard, and close the window. - - - The Select Account Type screen will be next if the wizard cannot determine your account type. Select your account type from the + + + Account Wizard 3 + + + + + + Account Wizard 2 + + + The account type selection dialogue + + + + + If the wizard cannot determine your account type, the Select Account Type screen will appear. Select your account type from the list (if you do not know, you will need to contact your email provider). If your account type is not listed, click the Check for more on Internet button. Once your account type has been selected, click the Next button, and you will be presented with the Personal Settings screen. - The Provide personal data screen will show again with the server details it found if the wizard was successful at determining the account type. - Click the Finish set up the account, complete the wizard and close the window. - - - - - The Personal Settings screen will show if you had to enter your account type. - Verify that your information is correct on this page. Select Download all messages for offline use - if you want your messages available when you do not have an Internet connection (&IMAP; only). - Click the Next button once finished. - - - Your account will then be set up, and you can click the Finish button to complete the wizard and close the window. - - - For manually creating accounts please continue reading the rest of this document. +   + + + + + If the wizard could not locate your email server by searching the internet, the Personal Settings + screen will appear. + + + Account Wizard 4 + + + + + + Account Wizard 2 + + + The "Personal Settings" dialogue + + + + + Be certain to enter all this information correctly. Select Download all messages for offline use + if you want your messages to be accessible when you do not have an Internet connection (&IMAP; only). + Click the Next button when finished. The Setup complete screen will appear. + + Your account has now been set up, and you can click the Finish button to complete the wizard and close the window, + or click the Details... button to review the account settings. +   + + + + If you wish to create an account manually, please continue reading this chapter. Otherwise, you may safely skip ahead + to Testing your Setup. Manual Configuration Quickstart -The Configure window consists of six sections: -Identities, Accounts, -Appearance, Composer, -Security, Misc, and -Plugins. - -To begin sending and receiving messages you will only have to -change some settings in the Identities and -Accounts pages. + + The configuration screen + + + + + + The configuration screen + + + &kmail;'s main configuration screen + + + +   + + The SettingsConfigure &kmail;... window consists of six sections: + Accounts, Appearance, Composer, + Security, Misc, and Plugins. + + To begin sending and receiving messages you will only have to + change some settings on the Accounts page. + Here is a brief synopsis of the steps you must take to set up a new mail account. + For a more detailed description, please read the + Configure &kmail; chapter. +   Setting your Identity + To create a new identity, click the Add... button on the + Identities tab associated with the Accounts page. + A small pop-up window will appear. + + + The new identity dialogue + + + + + + The new identity dialogue + + + Adding a new identity + + + + + You have some options here. Give the new identity a name, and select one of the + available choices ("With empty fields" or "Use System Settings values"). Then click + OK. The identity configuration screen will appear. +   + + + The new identity dialogue continues + + + + + + The new identity dialogue continues + + + Configuring the new identity + + + +   + - The settings in the Identities page are - fairly straightforward. Select your default identity and click - Modify. Fill in the Your - name field with your full name (⪚ John + The settings in the General tab are + fairly straightforward. Fill in the Your + name field with your full name (⪚, John Doe) and the Organization field (optional) with the appropriate information. - - Next, fill in the Email address field with your email address (⪚ john@example.net). @@ -134,201 +259,268 @@ change some settings in the Identities and linkend="configure-identity-cryptography">Cryptography tab. - + The Advanced and Templates tabs can + be used to tailor the way outgoing messages from this identy will be formatted and + processed. See Configure &kmail; for + more detailed instructions. + Optionally, go to the Signature tab and - enter your signature. This is a short text that will be + enter your signature. This is a short bit of verbiage that will be automatically appended to all your messages. It has nothing to - do with digital signatures. + do with digital signatures. You may also wish + to insert a small personal avatar in outgoing message headers via the + Picture tab. +   -Setting up your Account - -The Accounts 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 (ISP) or system -administrator. - - -Sending Messages - -The Sending tab provides a list of -ways to send messages. The first item in the list is the default -way to send messages. Using the Add... -button you can fill in the Name -field with a descriptive name -(⪚ My Mail Account). Click the Create and Configure -and fill the Outgoing mail server -field with the name and domain of your mail server -(⪚ smtp.provider.com). You will probably -not need to change the Port setting (the default is -25). - -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 -messages for different identities by selecting the Outgoing -Account check box in the Advanced -tab of the Identities page. - -A description of the other options can be found -in the Configuration -chapter. - - - -Options relevant to <acronym>Kolab</acronym> server - -When configuring an SMTP account with a Kolab server Host, you need to check the Server requires authentication option and to fill in your Kolab user's email address and password in the Login and Password fields. Then select the Security tab and click on the Check What the Server Supports for automated setup of your Security configuration. The default should be TLS/PLAIN. The Kolab server supports SSL/PLAIN as well. These settings may of course be configured manually. - + Setting up your Account + + The Accounts page also contains the settings that + tell &kmail; how to send and receive your email messages. Many of these settings + can vary greatly depending on the way your system is set up, and on the kind + of network in which your mail server is located. If you do not know what + setting to choose or what to put in a field, consult your ISP + (Internet Service Provider) or system administrator. - -Receiving Messages - -By default the Local Folders (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 Retrieval Options for these folders. - -To set up an account so you can receive mail, press the -Add... button in the Receiving -tab. You will then be prompted for the type of your email account. Most users should -select POP3 E-Mail Server or IMAP E-Mail Server. If -you want to use a local mailbox file, please see the FAQ -about file locking. - -You will then be presented with -the account settings window. First, fill in the -Account name field to name your account. You can choose any name -you like. Username, Password, and -Incoming mail server should be filled in with the appropriate information -from your ISP or system administrator. You should not -need to change the Port setting (the default for POP3 is -110, the default for &IMAP; is -143). - - -Options only relevant to &IMAP; - -If you check Automatically compact folders -&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 FileCompact All -Folders. -If you check Show hidden folders, -folders whose name starts with a dot are also displayed. - - - - -Options only relevant to POP3 - -Select Leave fetched messages on the server if you want to -leave your messages on the server after you downloaded them. - -Select Include in Manual Mail Check if you -want to check this account whenever you use FileCheck -Mail. If you unselect this option you can still check for new messages on this account -with FileCheck Mail -In. - -Select Enable interval mail checking if you want -&kmail; to check for new messages automatically. The interval can be specified below -under Check mail interval. - -inbox is the default folder for incoming -messages. If you want to change that for some reason, you can do so with -Destination folder. But what you probably want is a -filter, which has nothing to do with this -option. - -With Pre-command you can specify any program that &kmail; -will execute just before fetching mail. Please specify the full path -(do not use ~) and note that &kmail; will not continue -until the program returns. - -In the POP Settings group you can select Use -pipelining for faster mail download if this is supported by your -server. You should carefully test this to make sure it works safely. - - - -Options for both &IMAP; and POP3 -&kmail; supports encryption via SSL/TLS and -STARTTLS (SSL/TLS should be preferred -if it is available). - -For POP3 &kmail; supports: - - -Clear text, -PLAIN, -LOGIN, -CRAM-MD5 (recommended -if DIGEST-MD5 is not available), -DIGEST-MD5 (recommended), -NTLM, -GSSAPINTLM and -APOP authentication. - - -DIGEST-MD5, CRAM-MD5 and -APOP are secure on their own, the other -options are only secure when used together with SSL -or TLS. You should only use Clear -text if your server does not support any of the other -authentication methods. Additionally, for &IMAP; -Anonymous is supported, but APOP -is not. Use the Check what the server supports button -on the Security tab -to automatically select the most secure settings supported by your server. - -You are now ready to send and receive mail. For -&IMAP;, 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 -FileCheck -Mail. - - + + Sending Messages + Here's one way to create an outgoing mail account. + + + Outgoing account choices + + + + + + Outgoing account choices + + + Choosing an outgoing email account type + + + +   + + + + When you click the Add... button on the + Sending tab, this screen will appear. If + your computer is connected directly to the internet you will most + likely want to choose &SMTP;. If you need to use &Sendmail; + or &Microsoft; EWS, please consult the + Configuration + chapter. Whichever type of outgoing account you select, check the + box labeled "Make this the default outgoing account". (You can easily + change this later if you have more than one email account.) + + When you select the &SMTP; option and click the + ✓ Create and Configure button, the following + configuration screen will appear. +   + + + The sending configuration dialogue + + + + + + The sending configuration dialogue + + + Configuring an &SMTP; account + + + +   + + At a minimum, you must supply an email server &URI;. + If your email service requires authentication before sending messages, + check the "Server requires authentication" box and supply your email + address and password. If you want &kmail; to remember your password, + check the "Store SMTP password" box. If you have not yet created a + wallet, you will be asked to provide a password. + + Verify that the connection to the SMTP server is working by choosing + the Advanced tab and clicking the Auto + Detect button. &kmail; will query your &SMTP; server for the + correct settings (encryption, port number, and authentication method). After + the proper settings have been detected, the outgoing account is ready to + use. (Please refer to Configuration + if the &SMTP; connection requires additional fine tuning.) +   - + + Receiving Messages + + By default the Local Folders (inbox, outbox, sent-mail, + trash, drafts, and templates) in the primary &kmail; folder are predefined on this tab. + Using the drop down box you can set the Retrieval Options for these folders. + (Note that &kmail; uses the Maildir format to store messages on your hard disk: each message is + stored as a separate file. The exact location of the primary &kmail; directory depends on the &Linux; + distribution you have installed, but it is probably in ~/.local/share/ somewhere.) + + To set up an account so you can receive mail, press the + Add... button on the Receiving + tab. Choose "Custom Account..." from the drop down list. You will then be prompted for the account type. Most users will + select POP3 E-Mail Server or IMAP E-Mail Server. If you want + to use a local mailbox file (Mbox), please see the FAQ + about file locking. + + + The receiving configuration dialogue + + + + + + The receiving configuration dialogue + + + Configuring an &IMAP; account + + + +   + + If you chose &POP3; or &IMAP;, the account settings window will appear. First, fill in the + Account Name field to name your account. You can choose any name + you like. Username, Password, and Incoming mail + server (or IMAP Server) should be filled in with the appropriate information + from your ISP or system administrator. If you want &kmail; to check for new + messages automatically, check the Enable interval mail checking box and set + the time interval you desire. + + Next, click on the Advanced tab and then the Auto + Detect button. &kmail; will query your incoming message server to determine the + correct settings for this account (encryption, port number, and authentication method). + + + Options only relevant to IMAP + + If you check Automatically compact folders + on the Advanced configuration tab, &kmail; removes the messages + you deleted from the server as soon as you leave that folder. Otherwise, + the messages are only marked as deleted and it is up to you to compact + the folders manually. + + + + + + Options only relevant to POP3 + + Select Leave fetched messages on the server + on the Advanced configuration tab if you want to + leave your messages on the server after you have downloaded them. There are + seven ways to specify how long old messages will be kept after being downloaded: + indefinitely (leave all options unselected), or number of days / number + of messages / maximum size of server side inbox (choose one, two, or all three). If + this box is not checked, all messages will be immediately deleted from the remote + server after downloading is complete. + + On the Advanced tab you can also select Use + pipelining for faster mail download if this is supported by your + server. Test this to make sure it works safely. + + The inbox is the default folder for incoming + messages. If you want to change that for some reason, you can do so with + Destination folder. But what you probably want is a + filter. + + With Pre-command you can specify a program that &kmail; + should execute before fetching mail. Please specify the full path + (do not use ~) and note that &kmail; will not continue + until the program returns. + + + + + Options for both IMAP and POP3 + + On the Receiving tab, under Retrieval Options, + select Include in Manual Mail Check if you + want to check this account whenever you invoke FileCheck + Mail. If you do not select this option you can still check for new messages on this account + with FileCheck Mail In > . + + &kmail; supports encryption via SSL/TLS and + STARTTLS (SSL/TLS should be preferred + if it is available). + + &kmail; supports nine authentication methods: + + + Clear text, + PLAIN, + LOGIN, + CRAM-MD5 (recommended + if DIGEST-MD5 is not available), + DIGEST-MD5 (recommended), + NTLM, + GSSAPINTLM, + APOP (aka Anonymous), and + Gmail. + + + DIGEST-MD5, CRAM-MD5 and + APOP are secure on their own. The other + options are only secure when used together with SSL + or TLS. You should only use Clear + text if your server does not support any of the other + authentication methods. Anonymous is supported on + &IMAP;, but APOP is not. Gmail + authentication is only available for &IMAP; accounts using Google's GMail service. + + Use the Auto Detect button on the Advanced tab + to automatically select the most secure settings supported by your server. + + You are now ready to receive mail. For + &IMAP;, 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 + FileCheck + Mail. + + + - -Testing your Setup - -First, you should send yourself a message to test your -configuration. To send a message, either hit &Ctrl;N, select the -New Message icon or select -the MessageNew -Message... menu item. The -composer window will appear. Fill in the -To: field with your email address and type -something in the Subject field. Send the message by -selecting Message Send Mail -. - -To check your email, select -FileCheck -Mail. 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 -Settings Configure -&kmail;.... + + Testing your Setup + + First, you should send yourself a message to test your + configuration. To send a message, either hit &Ctrl;N, select the +  New button, or select + the MessageNew + Message... menu item. The + composer window will appear. Fill in the + To: field with your email address and type + something in the Subject field. Send the message by + selecting MessageSend Mail + . + + To check your email, select + FileCheck + Mail. 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 + Settings Configure + &kmail;.... + diff --git a/doc/kmail2/index.docbook b/doc/kmail2/index.docbook index 26caa0c72..5e39d3df3 100644 --- a/doc/kmail2/index.docbook +++ b/doc/kmail2/index.docbook @@ -10,14 +10,6 @@ - GPG"> - GpgSM"> - MDN"> - ACL"> - NNTP"> - OpenPGP"> - S/MIME"> - Kolab"> ]> @@ -75,6 +67,10 @@ &Scarlett.Clark.mail; + +&David.Bryant; +&David.Bryant.mail; + @@ -99,10 +95,14 @@ 2013 &Laurent.Montel; + +2020 +&David.Bryant; + &FDLNotice; 2020-08-14 -(&kde;5.14.3) +&kde;5.14.2 (20.04.2) diff --git a/doc/kmail2/intro.docbook b/doc/kmail2/intro.docbook index a27d11cea..22b0ef3d0 100644 --- a/doc/kmail2/intro.docbook +++ b/doc/kmail2/intro.docbook @@ -10,10 +10,14 @@ &Scarlett.Clark; &Scarlett.Clark.mail; + +&David.Bryant; +&David.Bryant.mail; + -2013-12-12 -&kde; 4.12 +2020-08-16 +&kde; 5.14.2 (20.04.2) @@ -35,43 +39,43 @@ The &kmail; Team welcomes you to &kmail;, a user-friendly email client by &kde;. -Our goal is to make &kmail; a program that is beautiful and intuitive without sacrificing power. +Our goal is to make &kmail; a program that is both beautiful and intuitive without sacrificing power. If you have never set up an email client on a &UNIX; system before, we suggest that you read through the Getting Started section first. Some &kmail; Features -Some links to the great features available in &kmail; +Here is a brief guide to some of the great features available in &kmail; -You do not have to use your mouse to use &kmail;. Everything can -be done by using Keyboard Shortcuts. +You do not have to use your mouse when working with &kmail;. Everything can +be done with Keyboard Shortcuts. -Although &kmail; can be considered reliable you should keep -backups of your messages, &ie; use one of the export/archive options listed in Backup Options to backup your settings and email to a safe place. +Although &kmail; is very reliable, you should keep +backups of your messages, &ie;, use one of the export/archive options listed in Backup Options to back up your settings and email regularly. -&kmail; is capable of importing email in several formats from your previous email applications using -options in Restore and Import in &kmail;. +&kmail; makes it easy to import email from many different email applications. +The options are described in Restore and Import in &kmail;. -Organize your folders with ease using &kmail;s extensive Folders options. -Some of the features include handling per folder: mailing lists, acl (&IMAP; only), and archiving. +You can separate your messages into different categories by using &kmail;'s extensive Folders options. + Features include special handling for specified folders: mailing lists, acl (&IMAP; only), and archiving. -Compliment your folder setup with highly configurable filters. +You can complement your folder setup with highly configurable filters. By default &kmail; will detect common email scams. -You can also fight SPAM and viruses with built in wizards to work with external programs to scan email as it comes in. -See Anti Spam Wizard and Anti-Virus-Wizard +You can also fight SPAM and viruses by creating filters that work with external programs to scan email as it comes in. +See Anti Spam and Anti Virus for details. -Easily manage per-account settings using multiple identities. +It's easy to manage several email accounts by using different identities. We hope you will enjoy &kmail;! @@ -80,7 +84,7 @@ for details. If you experience any problems migrating to &kmail; 2 please read the chapter Troubleshooting. &kmail;'s homepage can be found at https://userbase.kde.org/KMail. There you will -find useful links, ⪚ to the user and developer mailing lists. Please report bugs in &kmail; using +find useful links (⪚, to the user and developer mailing lists, and to the community wiki pages.) Please report any bugs in &kmail; using HelpReport Bug.... diff --git a/doc/kmail2/kmailwelcome.png b/doc/kmail2/kmailwelcome.png index d7149ac3d..3cd7aa37c 100644 Binary files a/doc/kmail2/kmailwelcome.png and b/doc/kmail2/kmailwelcome.png differ diff --git a/doc/kmail2/mail-message-new.png b/doc/kmail2/mail-message-new.png new file mode 100644 index 000000000..8730e9090 Binary files /dev/null and b/doc/kmail2/mail-message-new.png differ diff --git a/doc/kmail2/newidentity.png b/doc/kmail2/newidentity.png new file mode 100644 index 000000000..fde073874 Binary files /dev/null and b/doc/kmail2/newidentity.png differ diff --git a/doc/kmail2/newidentity2.png b/doc/kmail2/newidentity2.png new file mode 100644 index 000000000..1cc7e5856 Binary files /dev/null and b/doc/kmail2/newidentity2.png differ diff --git a/doc/kmail2/receiving.png b/doc/kmail2/receiving.png new file mode 100644 index 000000000..5fde547fe Binary files /dev/null and b/doc/kmail2/receiving.png differ diff --git a/doc/kmail2/sending.png b/doc/kmail2/sending.png new file mode 100644 index 000000000..b49452e0e Binary files /dev/null and b/doc/kmail2/sending.png differ diff --git a/doc/kmail2/sending2.png b/doc/kmail2/sending2.png new file mode 100644 index 000000000..0cbac7fd5 Binary files /dev/null and b/doc/kmail2/sending2.png differ