Some Fossies usage hints in advance:

To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies offlineimap-7.3.4.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).

Financial contributors:

Links:

Official github code repository: offlineimap
Website: website
Wiki: wiki
Blog: blog

OfflineIMAP

"Get the emails where you need them."

The offlineimap project is about python2 oonly. The support for offlineimap3 is happening in Official offlineimap for python3.

I'll still lazily maintain offlineimap but users should definitely go with offlineimap3.

Description

OfflineIMAP is software that downloads your email mailbox(es) as local Maildirs. OfflineIMAP will synchronize both sides via IMAP.

Why should I use OfflineIMAP?

IMAP's main downside is that you have to trust your email provider to not lose your email. While certainly unlikely, it's not impossible. With OfflineIMAP, you can download your Mailboxes and make you own backups of your Maildir.

This allows reading your email offline without the need for your mail reader (MUA) to support IMAP operations. Need an attachment from a message without internet connection? No problem, the message is still there.

Project status and future

The offlineimap project was forked to offlineimap3 to support python3. Contributions are welcome to this project.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

GNU General Public License v2.

Downloads

You should first check if your distribution already packages OfflineIMAP for you. Downloads releases as tarball or zipball.

If you are running Linux Os, you can install offlineimap with:

openSUSE zypper in offlineimap
Arch Linux pacman -S offlineimap
fedora dnf install offlineimap

Feedbacks and contributions

The user discussions, development, announcements and all the exciting stuff take place on the mailing list. While not mandatory to send emails, you can subscribe here.

Bugs, issues and contributions can be requested to both the mailing list or the official Github project. Provide the following information:

system/distribution (with version)
offlineimap version (offlineimap -V)
Python version
server name or domain
CLI options
Configuration file (offlineimaprc)
pythonfile (if any)
Logs, error
Steps to reproduce the error

The community

OfflineIMAP's main site is the project page at Github.
There is the OfflineIMAP community's website.
And finally, the wiki.

Requirements & dependencies

Python v2.7.x
six (required)
rfc6555 (required)
imaplib2 >= 2.57 (optional)
gssapi (optional), for Kerberos authentication
portalocker (optional), if you need to run offlineimap in Cygwin for Windows
Python v3: See the offlineimap3 fork of offlineimap.

Documentation

All current and updated documentation is on the community's website.

Read documentation locally

You might want to read the documentation locally. Get the sources of the website. For the other documentation, run the appropriate make target:

$ ./scripts/get-repository.sh website
$ cd docs
$ make html  # Requires rst2html
$ make man   # Requires a2x (http://asciidoc.org)
$ make api   # Requires sphinx