Go to file
Tobias Manske 1065d93415
All checks were successful
continuous-integration/drone/push Build is passing
Run every 15 minutes
2024-02-12 15:47:04 +01:00
.github remove requests for reviews in github 2020-09-06 11:41:11 +02:00
bin Changed environment to python3 in offlineimap 2020-08-29 08:11:56 +02:00
contrib Included contrib nametrans_imap_to_utf8.py 2020-11-10 23:32:31 +01:00
docs docs/website-doc.sh: minor improvements in comments of versions.yml 2018-06-16 15:29:11 +02:00
offlineimap Merge pull request #116 from lilydjwg/master 2022-12-05 11:40:38 +01:00
scripts scripts/get-repository.sh.rej: remove unused file 2017-01-31 01:01:53 +01:00
test Test global calls AttributeError 2020-10-25 19:34:52 +01:00
tests Autmomated testing using Travis and CodeCov.io! 2018-03-05 19:31:51 +01:00
.coveragerc Autmomated testing using Travis and CodeCov.io! 2018-03-05 19:31:51 +01:00
.drone.yml Add drone config 2023-10-28 15:23:46 +02: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
BACKERS.md Create BACKERS.md (#145) 2023-03-30 07:22:03 -04:00
Changelog.maint.md v6.7.0.3 2016-07-26 08:46:22 +02:00
Changelog.md v8.0.0 2021-10-18 15:00:16 +02:00
CODE_OF_CONDUCT.md 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
Dockerfile Run every 15 minutes 2024-02-12 15:47:04 +01:00
entrypoint.sh Run every 15 minutes 2024-02-12 15:47:04 +01:00
MAINTAINERS.rst Updated MAINTAINERS.rst and README.md 2020-12-28 18:10:21 +01:00
Makefile Makefile: targz: don't set the abbrev in the archive directory name 2018-04-09 17:17:49 +02:00
MANIFEST.in MANIFEST: exclude rfcs 2016-02-27 05:25:09 +01:00
offlineimap.conf Communicate syncmode to synchooks 2021-09-07 09:43:16 +02:00
offlineimap.conf.minimal Improve nametrans user documentation 2012-02-13 16:09:32 +01:00
offlineimap.py offlineimap.py using env python3 2020-08-29 08:30:38 +02:00
README.md Arch package install command. 2023-05-19 01:43:18 -04:00
requirements.txt requirements.txt: update imaplib2 version requirement 2021-08-03 00:41:22 +02:00
setup.cfg pypi requires a setup.cfg when README is Markdown 2016-02-27 05:34:46 +01:00
setup.py setup.py code style 2020-10-25 19:23:52 +01:00
snapcraft.yaml snapcraft uses python3 2020-08-29 09:15:00 +02:00
TODO.rst update TODO.rst 2015-11-23 02:24:33 +01:00

Upstream status (master branch): OfflineIMAP build status on Travis-CI.org OfflineIMAP code coverage on Codecov.io Gitter chat

Upstream status (next branch): OfflineIMAP build status on Travis-CI.org



"Get the emails where you need them."


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

OfflineIMAP, using Python 3, is based on OfflineIMAP for Python 2. Currently we are updating the source code. These changes should not affect the user (documentation, configuration files,... are the same) but some links or packages could refer to the Python 2 version. In that case, please open an issue.


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, you can install offlineimap with:

  • openSUSE zypper in offlineimap
  • fedora dnf install offlineimap
  • Arch Linux: pacman -S offlineimap, or through AUR package offlineimap3-git
  • Docker image: offlineimap/offlineimap:latest (note: image not published yet, just an example)

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 v3+
  • rfc6555 (required)
  • imaplib2 >= 3.5
  • gssapi (optional), for Kerberos authentication
  • portalocker (optional), if you need to run offlineimap in Cygwin for Windows


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