imap-backup

Backup, restore and migrate email accounts.

The backups can then be restored, used to migrate to another service, inspected or exported.

• Source Code
• Code Documentation
• Rubygem
• CI Status

Installation

Homebrew (macOS)

If you have Homebrew, do this:

brew install imap-backup

As a Ruby Gem

gem install imap-backup

If that doesn't work, see the detailed installation instructions.

From Source Code

If you want to use imap-backup directly from the source code, see here.

Setup

As a first step, you need to add accounts via a menu-driven command line program:

Run:

imap-backup setup

GMail

To use imap-backup with GMail, you will need to enable 'App passwords' on your account.

Backup

Manually, from the command line:

imap-backup

Alternatively, add it to your crontab.

Commands

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

For a full list of available commands, run

imap-backup help

For more information about a command, run

imap-backup help COMMAND

Troubleshooting

If you have problems:

1. ensure that you have the latest release,
2. turn on debugging output via the imap-backup setup main menu.

Development

See the Development documentation for notes on development and testing.

See the CHANGELOG to a list of changes that have been made in each release.