# The &i18n-archivemailagent; Handbook

## Introduction

&i18n-archivemailagent; is an Akonadi agent which allows to archive mail folders automatically.

### Using &i18n-archivemailagent;

Use Settings Configure Automatic Archiving... in &kmail;'s reader window to open a dialog to set up automatic archiving of mail folders.

This is a powerful tool that can be used to assist in backing up your email. To use this, click the Add... button, and the Add Archive Mail dialog will pop up.

Add Archive Mail dialog Add Archive Mail dialog

Add Archive Mail dialog

- First select the folder you would like to archive.

- Select the format you would like to save it in. ⪚ `.tar.bz2` in the drop down list. The archive filename will consist of the prefix `Archive_`, the path of the selected folder in &kmail;'s folder list, the date in format `year-month-day` and the selected file extension ⪚ `Archive_Local Folder_inbox_2019-09-03.tar.bz2`.

- By default Archive all subfolders is enabled. Uncheck this if you only want the parent folder archived.

- You can type in the location you would like to save your archive, or click the Open File Dialog button to select the folder.

- Select how often you wish to backup through the dropdown menus next to Backup each:.

- If you are limited on drive space you will want to set a limit on Maximum number of archive:

If you have added or modified an archive job it will be executed automatically after closing the dialog.

If you have already added mail archive jobs the Configure Archive Mail Agent dialog will list and allow to modify them.

Configure Archive Mail Agent Configure Archive Mail Agent

Configure Archive Mail Agent

You can use the checkbox at the left of each entry in the list to enable or disable archiving of this job.

It is possible to access this configurational dialog any time later using Settings Configure &kmail;... then select the Plugins page in &kmail; main window and pressing the configuration button against the Archive Mail Agent item.

Using the context menu launched with a &RMB; click on an archive job you can open the folder containing the archives or start the archive job immediately. This will overwrite an existing archive created earlier at the same day without notification.

### Credits and License

&i18n-archivemailagent;

Program copyright 2013-2019 Laurent Montel montel@kde.org

Documentation Copyright © 2013-2019 Laurent Montel montel@kde.org

&underFDL; &underGPL;