Repository files navigation

Backup, restore and migrate email accounts.

brew install imap-backup# for macOSgem install imap-backup --no-document# for Linuximap-backup setupimap-backup

There are two types of backups:

• Keep all (the default) - progressively saves a local copy of all emails,
• Mirror - adds and deletes emails from the local copy to keep it up to date with the account.

• Migrate - use the local copy to populate emails on another account. This is a once-only action that deletes any existing emails on the destination account.
• Mirror - make a destination account match the local copy. This action can be repeated.
• Restore - push the local copy back to the original account.

See below for afull list of commands.

docker run \  --volume ./my-data:/data \  --dns 8.8.8.8 \  ghcr.io/joeyates/imap-backup:latest \  imap-backup single backup \    --email me@example.com \    --password mysecret \    --server imap.example.com \    --path /data/me_example.com

docker run --env THE_PASSWORD=$THE_PASSWORD \  ... \  imap-backup single backup \    --password-environment-variable=THE_PASSWORD \    ...

docker run \  ... \  imap-backup single backup \    --password-file=/data/password.txt \    ...

docker run \  --volume ./my-config:/config \  --volume ./my-data:/data \  --dns 8.8.8.8 \  --tty \  --interactive \  ghcr.io/joeyates/imap-backup:latest \  imap-backup setup \    --config /config/imap-backup.json

docker run \  --volume ./my-config:/config \  --volume ./my-data:/data \  --dns 8.8.8.8 \  ghcr.io/joeyates/imap-backup:latest \  imap-backup backup \    --config /config/imap-backup.json

brew install imap-backup

gem install imap-backup --no-document

Normally you will want to backup a number of email accounts.Doing so requires the creation of a config file.

You do this via a menu-driven command line program:

Run:

imap-backup setup

As an alternative, if you only want to backup a single account,you can pass all the necessary parameters directly to thesingle backup command(see thesingle backup docs).

To use imap-backup with GMail, Office 365 and other services that requireOAuth2 authentication, you can useemail-oauth2-proxy.Seethis blog post about using imap-backup with email-oauth2-proxy.

Manually, from the command line:

imap-backup

Alternatively, add it to your crontab.

Backups can also be inspected, for example vialocal showand exported viautils export-to-thunderbird.

• backup
• local accounts
• local check
• local folders
• local list
• local show
• migrate
• mirror
• remote folders
• restore
• setup
• single backup
• utils export-to-thunderbird
• utils ignore-history

For a full list of available commands, run

imap-backuphelp

For more information about a command, run

imap-backuphelp COMMAND

There are a couple of performance tweaks that you can useto improve backup speed.

These are activated via two settings:

• Global setting "Delay download writes",
• Account setting "Multi-fetch size".

Seethe performance document for more information.

If you have problems:

1. ensure that you have the latest release,
2. runimap-backup with the-v or--verbose parameter.

See theDeveloper Documentation.