dovecot-archive is a doveadm wrapper for common mail archival tasks.
Usage
required arguments:
- --user USER, -u USER
Source user whose mails will be moved.
optional arguments:
- --folder FOLDER, -f FOLDER
Source folder which will be moved including its subfolders. If not given, all user’s folders will be moved
- --dst-user DST_USER, -d DST_USER
Destination user to whom will the mails be moved. If not given, source user will be used.
- --dst-root-folder DST_ROOT_FOLDER, -r DST_ROOT_FOLDER
Destination root folder to move the folder structure into, e.g. ‘Archive’. If not given, root namespace will be used.
- --before BEFORE, -b BEFORE
Move only mails sent before this date. The date needs to supplied as unix timestamp, ISO-8601 (YYY-MM-DD), IMAP4rev1 (DD-Mon-YYYY) or a human readable representation of elapsed time (e.g. “2 months”, “3y”). If not given, all mails will be moved.
- --since SINCE, --after SINCE, -a SINCE
Move only mails sent after this date. The date needs to supplied as unix timestamp, ISO-8601 (YYY-MM-DD), IMAP4rev1 (DD-Mon-YYYY) or a human readable representation of elapsed time (e.g. “2 months”, “3y”). If not given, all mails will be moved.
- --split-by-year, -y
Create subfolders with the respective years in the destination folder structure as [/dst-root-folder]/<year>/<folder>/<subfolder>. If not given, folders will be moved as a whole.
- --year-as-last-folder, -l
Create subfolders with the respective years as the last folder in the hierarchy as [/dst-root-folder]/<folder>/<subfolder>/<year>. Effective only when –split-by-year is used.
- --copy, -c
Copy the mails instead of moving. If not given the mails are removed from the source location after successful move.
- --namespace-separator, -s
Delimiter character used to separate Dovecot mailbox path components (i.e. not a filesystem directory separator).
- --verbose, -v
Print informational (-v) and debug (-vv) messages. If not given, the tool is silent and outputs only fatal errors.
Use cases
Scenario 1)
I have way too many mails and it makes my e-mail client slow. I want to move sent and received mails older than 3 years to a different user/account (which I only open in my e-mail client when I really need to), and I want to retain the same folder structure of the mailboxes as I have under the current user/account. I don’t want to archive thrash, spam, etc.
Create a weekly cron task:
dovecot-archive --user original.user@example.com --dst-user archival.user@example.com --folder INBOX --folder Sent --before "3 years"Scenario 2)
I have way too many mails and I want to move mails older than 14 days into an archive folder under the same user/account. I also want to create a subfolder for every year.
Create a daily cron task:
dovecot-archive --user user@example.com --folder INBOX --dst-root-folder Archive --split-by-year --before "14 days"Scenario 3)
An employee is leaving the company and I want to move all their mail from 2020 onward to a new user/account of the employee replacing them. I want to move the whole folder structure, but to place it under a subfolder so it doesn’t interfere with the new employee’s mails.
Manually run once:
dovecot-archive --user leaver@example.com --dst-user joiner@example.com --dst-root-folder "Jane Doe" --since 2020-01-01Changelog
1.2.0
Added --since parameter.
Updated datetime handling.
1.1.0
Added --namespace-separator parameter used to separate Dovecot mailbox path components.
1.0.1
Initial release.
1 maintainer
Metadata
1 maintainer
Release files for dovecot-archive 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dovecot_archive-1.2.0.tar.gz | 10.4 kB | Without provenance | Details for dovecot_archive-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dovecot_archive-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for dovecot_archive-1.2.0-py3-none-any.whl |
Total release size: 19.4 kB
Release files / dovecot_archive-1.2.0.tar.gz
| Download URL | dovecot_archive-1.2.0.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a605eaa6db9bfcf9058803f0f6b03d1a2ccbf24905f51784c68f09b384f36bc8
|
|
BLAKE2b-256 checksum How to use checksums |
0d3e966e17569b3873303370ea6910d4ea633973f0835645c0b0b7011ed7eb38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / dovecot_archive-1.2.0-py3-none-any.whl
| Download URL | dovecot_archive-1.2.0-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
209af88906622a429e25330fafc0ff4afc48141f3ef1413a6f111a285b0d0ebe
|
|
BLAKE2b-256 checksum How to use checksums |
99bdf56e8d5920c88a8f94a862da04626d493779031d36b78beca25535d43937
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Security for dovecot-archive 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
