|Original author(s)||John Goerzen|
|Developer(s)||Nicolas Sebrecht et al.|
|Stable release||7.2.4 (June 8, 2019)|
|Written in||Python 2|
|Operating system||Unix-like, Windows|
OfflineIMAP is IMAP synchronization utility software, capable of synchronizing mail on IMAP server with local Maildir folder or another server.
The synchronization is performed bidirectionally between two endpoints ("Remote" and "Local" repositories).
OfflineIMAP accesses mail servers only via Internet Message Access Protocol (Post Office Protocol – another popular way to get mail from server – is not supported), it works faster (though it is sensitive to connection's latency) and supports more advanced features than most mail clients. The special mode for better handling the non-standard implementation of IMAP in Gmail may optionally be enabled in a configuration file.
When configured to store mail locally, OfflineIMAP uses the Maildir format. Unix mail boxes support may be added in the future, though currently it is not implemented.
Several synchronizations account, each consisting of Remote and Local repositories, may be defined in configuration file. Each repository is then configured separately, allowing to specify credentials and access method.
OfflineIMAP is capable of filtering the folders of Remote repository, so that only partial synchronization would occur if needed. To use this capability one has to define the mask that would be matched against the list of folders with each synchronization. This is achieved by using Python's lambda capability; for example, to synchronize only "INBOX", "Sent Mail" and "Received" folders one should specify the following rule:
folderfilter = lambda foldername: foldername in [ 'INBOX', 'Sent Mail', 'Received']
Remaining folders' names may be altered (translated) using similar construct:
nametrans = lambda foldername: re.sub( "^Sent$", "root/Sent", re.sub("^(\[G.*ail\]|INBOX)", "root", foldername) )
This technique may also be used to synchronize the content of an IMAP server to the folder of another server.
Each account has to use separate directory; otherwise the synchronization process may suffer from unexpected behavior or even data loss.
OfflineIMAP provides several command-line interfaces, including interactive color curses-based, non-interactive console logging, and several yet less verbose modes. Tk-based graphical user interface is also available.