offlineimap

synchronizes IMAP mailboxes with local Maildir storage

TLDR

Sync all accounts

$ offlineimap

Sync specific account

$ offlineimap -a [account_name]

Sync specific folder

$ offlineimap -f [INBOX]

Dry run (show what would happen)

$ offlineimap --dry-run

Quick sync (skip flag sync)

$ offlineimap -q

Sync once and exit

$ offlineimap -o

Sync with custom config

$ offlineimap -c [/path/to/config]

Show folder list

$ offlineimap --info

SYNOPSIS

offlineimap [-a account] [-f folder] [-o] [-q] [options]

offlineimap synchronizes IMAP mailboxes with local Maildir storage. It enables offline access to email and backup of IMAP accounts.Bidirectional sync keeps local and remote in agreement. New messages, deletions, and flag changes propagate both ways. Conflicts are handled according to configuration.Maildir format stores each message as a file, enabling access by mail clients like mutt, notmuch, and others. The local copy works when offline.Configuration defines accounts, servers, and folder mappings. Multiple accounts can sync independently. Folder filtering controls which mailboxes to mirror.OAuth2 authentication works with Gmail and other providers requiring modern auth. Password storage can use system keyrings or external commands.Quick mode speeds up syncs by skipping unchanged folders. One-shot mode runs once without repeated checking.

PARAMETERS

-a ACCOUNT

Sync specific account.

-f FOLDER

Sync specific folder.

-o

One-time sync (no repeat).

-q, --quick

Quick sync, skip flags.

-c FILE

Configuration file.

-u UI

User interface (quiet, basic, blinkenlights).

--dry-run

Show actions without executing.

--info

Show account/folder info.

-l FILE

Log file.

--version

Show version.

INSTALL

sudo dnf install offlineimap

sudo pacman -S offlineimap

sudo apk add offlineimap

brew install offlineimap

nix profile install nixpkgs#offlineimap

CAVEATS

Initial sync of large mailboxes takes time. Configuration can be complex. Deprecated in favor of isstralsync. Gmail quirks may need special handling.

HISTORY

offlineimap was created by John Googin around 2002 for syncing IMAP mail to local storage. It became essential for offline email workflows. The project is now in maintenance mode, with isstralsync as the recommended successor.