Skip to content
Read/sync your IMAP mailboxes
Python Shell Makefile
Branch: master
Clone or download
nicolas33 introduce FUNDING.yml for opencollective
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
Latest commit c536645 Dec 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github introduce FUNDING.yml for opencollective Dec 5, 2019
bin bin/offlineimap: fix shebang to env python2 Mar 3, 2018
contrib ensure python2 in the release workflow Aug 19, 2019
docs make docs: ensure py2 when running sphinx Aug 19, 2019
offlineimap Additional address for sysloghandler to handle mac Oct 12, 2019
scripts scripts/get-repository.sh.rej: remove unused file Jan 31, 2017
test Autmomated testing using Travis and CodeCov.io! Mar 5, 2018
tests Autmomated testing using Travis and CodeCov.io! Mar 5, 2018
.coveragerc Autmomated testing using Travis and CodeCov.io! Mar 5, 2018
.gitignore gitignore: re-introduce *.css Mar 5, 2018
.travis.yml travis: remove python3.6 Jun 10, 2019
CODE_OF_CONDUCT.md code of conduct: try to clarify what item 3 might mean Jul 12, 2016
CONTRIBUTING.rst explain how to submit issues in more files Sep 9, 2016
COPYING COPYING: fix unexpected characters Jan 15, 2015
Changelog.maint.md v6.7.0.3 Jul 26, 2016
Changelog.md v7.3.0 Aug 19, 2019
MAINTAINERS.rst Add self to maintainers. Update email address. Apr 20, 2018
MANIFEST.in MANIFEST: exclude rfcs Feb 27, 2016
Makefile ensure python2 in the release workflow Aug 19, 2019
README.md update readme to give an hint about Linux distros Aug 17, 2019
TODO.rst update TODO.rst Nov 23, 2015
offlineimap.conf offlineimap.conf: minor fixes Dec 1, 2018
offlineimap.conf.minimal Improve nametrans user documentation Feb 13, 2012
offlineimap.py Update FSF postal address. Apr 6, 2019
requirements.txt implement Happy Eyeballs Jun 10, 2019
setup.cfg pypi requires a setup.cfg when README is Markdown Feb 27, 2016
setup.py Update FSF postal address. Apr 6, 2019
snapcraft.yaml Initial commit of snapcraft.yaml Dec 20, 2017

README.md

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

Links:

OfflineIMAP

"Get the emails where you need them."

Official offlineimap.

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

As one of the maintainer of OfflineIMAP, I'd like to put my efforts into imapfw. imapfw is software in development that I intend to replace OfflineIMAP with in the long term.

That's why I'm not going to continue OfflineIMAP development. I'll continue to maintain OfflineIMAP (fixing small bugs, reviewing patches and merging, and rolling out new releases), but that's all.

While I keep tracking issues for OfflineIMAP, you should not expect future support.

You won't be left at the side. OfflineIMAP's community is large enough so that you'll find people for most of your issues.

Get news from the blog.

                             Nicolas Sebrecht. ,-)

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
  • archLinux 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+

  • 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.4+ [STALLED] (experimental: see known issues)

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
You can’t perform that action at this time.