Read/sync your IMAP mailboxes [Python]
Python Shell Makefile
Latest commit e57b499 Sep 21, 2016 @nicolas33 nicolas33 v7.0.7
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
Permalink
Failed to load latest commit information.
.github github template: add system/distribution Jul 28, 2016
bin Convert to use OptionParser for command line handling. Dec 15, 2010
contrib release.sh: minor enhancements Aug 13, 2016
docs manual: add known issue about netrc Jul 28, 2016
offlineimap v7.0.7 Sep 21, 2016
scripts DNS of the website changed, reflect it Mar 21, 2015
test Change filter with lambda to list comprehension May 10, 2016
.gitignore Add tags to gitignore May 5, 2016
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.0.7 Sep 21, 2016
MAINTAINERS.rst MAINTAINERS: update Feb 27, 2016
MANIFEST.in MANIFEST: exclude rfcs Feb 27, 2016
Makefile Really execute the recipe of the 'docs' target in top-most Makefile Mar 21, 2016
README.md README: minor copy edits Sep 14, 2016
TODO.rst update TODO.rst Nov 23, 2015
offlineimap.conf set singlethreadperfolder configuration option when in idle mode Sep 20, 2016
offlineimap.conf.minimal Improve nametrans user documentation Feb 13, 2012
offlineimap.py allow to run under python3 without special env Jun 3, 2016
requirements.txt move requirements.txt to the root directory Jun 7, 2016
setup.cfg pypi requires a setup.cfg when README is Markdown Feb 27, 2016
setup.py Add offlineimap.utils to the list of our modules Feb 5, 2013

README.md

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.

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.

Why should I use OfflineIMAP?

  • It is fast.
  • It is reliable.
  • It is flexible.
  • It is safe.

Downloads

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

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+
  • Python v3.4+ (experimental: see known issues)
  • six (required)
  • imaplib2 >= 2.55 (optional)

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