Read/sync your IMAP mailboxes (python2)
Go to file
Chris Coleman ffbace51a2
2023-03-30 07:19:04 -04:00
.github introduce FUNDING.yml for opencollective 2019-12-06 00:44:55 +01:00
bin bin/offlineimap: fix shebang to env python2 2018-03-03 01:43:31 +01:00
contrib contrib/ the version information has moved to offlineimap.version 2020-04-22 16:07:20 +02:00
docs make docs: ensure py2 when running sphinx 2019-08-19 19:33:34 +02:00
offlineimap v7.3.4 2021-08-03 01:07:23 +02:00
scripts scripts/ remove unused file 2017-01-31 01:01:53 +01:00
test Autmomated testing using Travis and! 2018-03-05 19:31:51 +01:00
tests Autmomated testing using Travis and! 2018-03-05 19:31:51 +01:00
.coveragerc Autmomated testing using Travis and! 2018-03-05 19:31:51 +01:00
.gitignore gitignore: re-introduce *.css 2018-03-05 19:35:13 +01:00
.travis.yml travis: remove python3.6 2019-06-10 17:36:20 +02:00 Update 2023-03-30 07:19:04 -04:00 code of conduct: try to clarify what item 3 might mean 2016-07-12 16:04:55 +02:00
CONTRIBUTING.rst explain how to submit issues in more files 2016-09-09 21:10:30 +02:00
COPYING COPYING: fix unexpected characters 2015-01-15 11:41:35 +01:00 v6.7.0.3 2016-07-26 08:46:22 +02:00 Changelog: fix version 2021-08-03 01:12:52 +02:00
MAINTAINERS.rst Add self to maintainers. Update email address. 2018-04-20 12:55:25 -04:00 MANIFEST: exclude rfcs 2016-02-27 05:25:09 +01:00
Makefile ensure python2 in the release workflow 2019-08-19 19:35:13 +02:00 README: rewording and typo fix 2021-08-03 01:24:07 +02:00
TODO.rst update TODO.rst 2015-11-23 02:24:33 +01:00
offlineimap.conf offlineimap.conf: minor fixes 2018-12-02 00:38:05 +01:00
offlineimap.conf.minimal Improve nametrans user documentation 2012-02-13 16:09:32 +01:00 Update FSF postal address. 2019-04-06 23:30:47 +02:00
requirements.txt Require the minimal dependencies in python package 2020-04-22 15:51:13 +02:00
setup.cfg pypi requires a setup.cfg when README is Markdown 2016-02-27 05:34:46 +01:00 contrib/ the version information has moved to offlineimap.version 2020-04-22 16:07:20 +02:00
snapcraft.yaml Initial commit of snapcraft.yaml 2017-12-20 08:38:18 +01:00

Financial contributors: Financial Contributors on Open Collective



"Get the emails where you need them."

IMPORTANT NOTE: This repository is for python2 only. The support for offlineimap3 is happening in Official offlineimap for python3.

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


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.


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]



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


GNU General Public License v2.


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

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.


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/ website
$ cd docs
$ make html  # Requires rst2html
$ make man   # Requires a2x (
$ make api   # Requires sphinx