[kde-doc-english] [kdepim/KDE/4.12] doc/kmail: Folder archive was integrated into kmail, therefore integrating the documentation.

[Burkhard Lück]

Git commit 570b512ead59a1b46036617f9b9e827f3d984d5d by Burkhard Lück, on behalf of Scarlett Clark.
Committed on 12/01/2014 at 16:21.
Pushed by lueck into branch 'KDE/4.12'.

Folder archive was integrated into kmail, therefore integrating the documentation.

REVIEW:114967
(cherry picked from commit 32781273bed1b9f95a9231540e8dc01a09798c2f)
backport to 4.12.3

A  +-    --    doc/kmail/folderarchiveagent.png
M  +43   -1    doc/kmail/using-kmail.docbook

http://commits.kde.org/kdepim/570b512ead59a1b46036617f9b9e827f3d984d5d

diff --git a/doc/kmail/folderarchiveagent.png b/doc/kmail/folderarchiveagent.png
new file mode 100644
index 0000000..9da23b1
Binary files /dev/null and b/doc/kmail/folderarchiveagent.png differ
diff --git a/doc/kmail/using-kmail.docbook b/doc/kmail/using-kmail.docbook
index af5b9d8..b611e17 100644
--- a/doc/kmail/using-kmail.docbook
+++ b/doc/kmail/using-kmail.docbook
@@ -1707,7 +1707,49 @@ you need to debug your filtering process.
 <varlistentry id="archive-folder">
 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Folder Archive Agent...</guimenuitem></menuchoice></term>
 <listitem>
-<para>This feature allows you to archive single emails to a specified folder. Please see <ulink url="help:/akonadi_folderarchive_agent">Folder Archive Agent</ulink> for details.</para>
+<para>This feature allows you to archive single emails to a specified folder.</para>
+<para>Folder Archive can be enabled on a per account basis to allow you to archive individual emails through the right click menu.</para>
+<screenshot>
+<screeninfo>Screenshot of Folder Archive</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="folderarchiveagent.png" format="PNG" />
+    </imageobject>
+  </mediaobject>
+</screenshot>
+<para>Folder Archive is used to archive single emails to a specified folder. For instance, you need to archive all of
+those pesky bill receipts in one place. Folder Archive can easily accommodate those needs. <action>Start by
+using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Folder Archive Agent...</guimenuitem></menuchoice>
+in &kmail;'s reader window to open a dialog to set up the folder archive agent.</action>
+</para>
+
+<para>This dialog will have a tab for each of your configured accounts including Local Folders and you will need to configure all accounts that you wish to
+use this feature with. The first option allows you to enable/disable the folder archive agent. It is disabled by default, to enable check the <guilabel>Enable</guilabel>
+checkbox. You can set the location of your Archive folder by clicking the folder icon next to
+<guilabel>Folder:</guilabel> and selecting the folder you wish to use. For example, you could create
+a folder called <quote>bill receipts</quote> by clicking the <guibutton>New Subfolder...</guibutton> and typing <userinput>bill receipts</userinput> in
+the dialog. You may choose a folder location anywhere, ⪚.. a folder in your <quote>Local Folders</quote> or on your &imap; server.</para>
+<para>
+You have several choices on how the emails will be archived:
+</para>
+<variablelist id="archivefolder-options">
+  <varlistentry>
+  <term><guilabel>Unique folder</guilabel></term>
+  <listitem><para>Uses the selected folder sorted by date.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><guilabel>Folder by months</guilabel></term>
+  <listitem><para>Creates new folders inside the selected folder by months.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><guilabel>Folder by years</guilabel></term>
+  <listitem><para>Creates new folders inside the selected folder by years.</para></listitem>
+  </varlistentry>
+</variablelist>
+<para>
+Now when you receive a bill receipt, &RMB; the email and select <guimenuitem>Archive</guimenuitem> from the menu. The email will be archived
+into your configured archive folder for easy viewing later on.
+</para>
 </listitem>
 </varlistentry>
 </variablelist>