OfflineIMAP

Last updated
OfflineIMAP
Original author(s) John Goerzen
Developer(s) Nicolas Sebrecht et al.
Initial release2002;21 years ago (2002)
Stable release 7.2.4 (June 8, 2019;3 years ago (2019-06-08)) [±] [1]
Repository
Written in Python 2
Operating system Unix-like, Windows
Available inEnglish
Type Email synchronization
License GNU GPLv2+
Website www.offlineimap.org

OfflineIMAP is IMAP synchronization utility software, capable of synchronizing mail on IMAP server with local Maildir folder [2] or another server.

Contents

Description

The synchronization is performed bidirectionally between two endpoints ("Remote" and "Local" repositories). [3]

OfflineIMAP accesses mail servers only via Internet Message Access Protocol (Post Office Protocol – another popular way to get mail from server – is not supported), [4] it works faster (though it is sensitive to connection's latency) and supports more advanced features than most mail clients. [5] The special mode for better handling the non-standard implementation of IMAP in Gmail may optionally be enabled in a configuration file. [6]

When configured to store mail locally, OfflineIMAP uses the Maildir format. [3] Unix mail boxes support may be added in the future, though currently it is not implemented. [6]

Configuration

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. [3]

Filtering and translation

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: [5]

folderfilter=lambdafoldername:foldernamein["INBOX","Sent Mail","Received"]

Remaining folders' names may be altered (translated) using similar construct: [3]

nametrans=lambdafoldername: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. [5]

Limitations

Each account has to use separate directory; otherwise the synchronization process may suffer from unexpected behavior or even data loss. [5]

User interface

OfflineIMAP provides several command-line interfaces, including interactive color curses-based, non-interactive console logging, and several yet less verbose modes. [3] Tk-based graphical user interface is also available. [5]

See also

Related Research Articles

<span class="mw-page-title-main">Email</span> Mail sent using electronic means

Electronic mail is a method of exchanging messages ("mail") between people using electronic devices. Email was thus conceived as the electronic (digital) version of, or counterpart to, mail, at a time when "mail" meant only physical mail. Email later became a ubiquitous communication medium, to the point that in current use, an email address is often treated as a basic and necessary part of many processes in business, commerce, government, education, entertainment, and other spheres of daily life in most countries.

In computing, the Internet Message Access Protocol (IMAP) is an Internet standard protocol used by email clients to retrieve email messages from a mail server over a TCP/IP connection. IMAP is defined by RFC 9051.

In computing, the Post Office Protocol (POP) is an application-layer Internet standard protocol used by e-mail clients to retrieve e-mail from a mail server. POP version 3 (POP3) is the version in common use, and along with IMAP the most common protocols for email retrieval.

<span class="mw-page-title-main">Email client</span> Computer program used to access and manage a users email

An email client, email reader or, more formally, message user agent (MUA) or mail user agent is a computer program used to access and manage a user's email.

<span class="mw-page-title-main">Maildir</span> E-mail format

The Maildir e-mail format is a common way of storing email messages in which each message is stored in a separate file with a unique name, and each mail folder is a file system directory. The local file system handles file locking as messages are added, moved and deleted. A major design goal of Maildir is to eliminate the need for program code to handle file locking and unlocking.

<span class="mw-page-title-main">Microsoft Outlook</span> Email, notes, task, calendar software and contact management.

Microsoft Outlook is a personal information manager software system from Microsoft, available as a part of the Microsoft Office and Microsoft 365 software suites. Though primarily an email client, Outlook also includes such functions as calendaring, task managing, contact managing, note-taking, journal logging and web browsing. And has also become a popular email client for many businesses.

procmail is an email server software component — specifically, a message delivery agent (MDA). It was one of the earliest mail filter programs. It is typically used in Unix-like mail systems, using the mbox and Maildir storage formats.

<span class="mw-page-title-main">Mutt (email client)</span> Text-based email client for Unix-like systems

Mutt is a text-based email client for Unix-like systems. It was originally written by Michael Elkins in 1995 and released under the GNU General Public License version 2 or any later version.

<span class="mw-page-title-main">Kontact</span> Personal information manager software

Kontact is a personal information manager and groupware software suite developed by KDE. It supports calendars, contacts, notes, to-do lists, news, and email. It offers a number of inter-changeable graphical UIs all built on top of a common core.

The Cyrus IMAP server is electronic mail server software developed by Carnegie Mellon University. It differs from other Internet Message Access Protocol (IMAP) server implementations in that it is generally intended to be run on sealed servers, where normal users cannot log in.

Calendaring Extensions to WebDAV, or CalDAV, is an Internet standard allowing a client to access and manage calendar data along with the ability to schedule meetings with users on the same or on remote servers. It lets multiple users in different locations to share, search and synchronize calendar data. It extends the WebDAV specification and uses the iCalendar format for the calendar data. The access protocol is defined by RFC 4791. Extensions to CalDAV for scheduling are standardized as RFC 6638. The protocol is used by many important open-source applications.

The UW IMAP server was the reference server implementation of the Internet Message Access Protocol. It was developed at the University of Washington by Mark Crispin and others.

Push email is an email system that provides an always-on capability, in which new email is actively transferred (pushed) as it arrives by the mail delivery agent (MDA) to the mail user agent (MUA), also called the email client. Email clients include smartphones and, less strictly, IMAP personal computer mail applications.

<span class="mw-page-title-main">Alpine (email client)</span> Email client

Alpine is a free software email client developed at the University of Washington.

A mailbox is the destination to which electronic mail messages are delivered. It is the equivalent of a letter box in the postal system.

<span class="mw-page-title-main">Windows Live Mail</span> Email client, electronic calendar and newsreader, developed by Microsoft

Windows Live Mail was a freeware email client from Microsoft. It is the successor to Windows Mail in Windows Vista, which was the successor to Outlook Express in Windows XP and Windows 98. Windows Live Mail is designed to run on Windows 7 and Windows Server 2008 R2, but is also compatible with Windows 8 and Windows 10, even though Microsoft bundles a new email client, named Windows Mail, with the latter.

MIX is a high-performance, indexed, on-disk email storage system that is designed for use with the IMAP protocol. MIX was designed by Mark Crispin, the author of the IMAP protocol. Server support for it has been included in releases of UW IMAP since 2006, Panda IMAP, and Messaging Architects Netmail. MIX is also supported directly by the Alpine e-mail client.

Exchange ActiveSync is a proprietary protocol designed for the synchronization of email, contacts, calendar, tasks, and notes from a messaging server to a smartphone or other mobile devices. The protocol also provides mobile device management and policy controls. The protocol is based on XML. The mobile device communicates over HTTP or HTTPS.

<span class="mw-page-title-main">GroupWise</span> Messaging and collaborative software platform

GroupWise is a messaging and collaboration platform from Micro Focus that supports email, calendaring, personal information management, instant messaging, and document management. The GroupWise platform consists of desktop client software, which is available for Windows,, and the server software, which is supported on Windows Server and Linux.

<span class="mw-page-title-main">Mail (Windows)</span> Conflation of two applications developed by Microsoft

Mail is an email client developed by Microsoft and included in Windows Vista and later versions of Windows. It is available as the successor to Outlook Express, which was either included with, or released for Internet Explorer 3.0 and later versions of Internet Explorer.

References

  1. "Changelog of mainline" . Retrieved June 19, 2018.
  2. Eckenfels, Mela (2011). "Drei Tools zum Archivieren von IMAP-Mails" [Three tools for archiving IMAP mails]. Linux Magazine.
  3. 1 2 3 4 5 Martin, Ben (May 6, 2008), "OfflineIMAP makes messages and attachments available locally", Linux.com , retrieved August 23, 2012
  4. Danen, Vincent (October 26, 2009), "Keep IMAP email messages locally using OfflineIMAP", TechRepublic , retrieved August 23, 2012
  5. 1 2 3 4 5 Goerzen, John (March 2004), "Fast Convenient Mail for Travel: OfflineIMAP", Linux Journal , no. 119, ISSN   1075-3583 , retrieved August 23, 2012
  6. 1 2 Brockmeier, Joe (January 31, 2011), "Use OfflineIMAP to Sync Email on the Go", ServerWatch, retrieved August 23, 2012