Go to file
Łukasz Żarnowiecki 23f96ba880 Encode utf-8 argument for md5 function
Python3 accepts binary input for md5 function.

This patch is known to break setups using folder names not strictly conforming
the IMAP UTF-7 encoding. We always made it clear that such setup is unsupported
and might be broken at some point in time. See documentation about
'decodefoldernames' in the provided configuration file. This is why this patch
is considered introducing no regression for this use case.

Patches to support both Python 3 and Python 2 by re-encoding the MD5 in the
filenames are welcome. This likely requires a new CLI option to allow
backporting the feature for users downgrading or changing of Python environment.

Signed-off-by: Łukasz Żarnowiecki <dolohow@outlook.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2016-05-17 00:44:02 +02:00
.github .github/: improve templates 2016-03-09 09:35:59 +01:00
bin Convert to use OptionParser for command line handling. 2010-12-15 20:02:27 +01:00
contrib release.sh: move the authors section up 2016-03-05 14:36:54 +01:00
docs manual: improve rendering 2016-04-11 13:22:54 +02:00
offlineimap Encode utf-8 argument for md5 function 2016-05-17 00:44:02 +02:00
scripts DNS of the website changed, reflect it 2015-03-21 13:40:06 +01:00
test Change filter with lambda to list comprehension 2016-05-10 02:53:09 +02:00
.gitignore Add tags to gitignore 2016-05-05 23:50:24 +02:00
Changelog.maint.md Changelogs: improve website formatting 2015-03-14 13:55:34 +01:00
Changelog.md v6.7.0 2016-03-10 17:08:18 +01:00
CODE_OF_CONDUCT.md introduce a code of conduct 2016-03-07 13:36:33 +01:00
CONTRIBUTING.rst update links to the new URL www.offlineimap.org 2016-02-19 12:10:23 +01:00
COPYING COPYING: fix unexpected characters 2015-01-15 11:41:35 +01:00
MAINTAINERS.rst MAINTAINERS: update 2016-02-27 20:10:34 +01:00
Makefile Really execute the recipe of the 'docs' target in top-most Makefile 2016-03-21 18:41:41 +01:00
MANIFEST.in MANIFEST: exclude rfcs 2016-02-27 05:25:09 +01:00
offlineimap.conf conf: newmail_hook is a remote option 2016-05-12 18:04:41 +02:00
offlineimap.conf.minimal Improve nametrans user documentation 2012-02-13 16:09:32 +01:00
offlineimap.py Add friendly message about Python 3.x being unsupported 2014-05-23 21:50:46 +04:00
README.md README: add slogan 2016-03-02 15:36:22 +01:00
setup.cfg pypi requires a setup.cfg when README is Markdown 2016-02-27 05:34:46 +01:00
setup.py Add offlineimap.utils to the list of our modules 2013-02-05 07:38:11 +04:00
TODO.rst update TODO.rst 2015-11-23 02:24:33 +01:00

OfflineIMAP

Get the emails where you need them.

Description

OfflineIMAP is a software to dispose your e-mail mailbox(es) as a local Maildir. OfflineIMAP will synchronize both sides via IMAP.

The main downside about IMAP is that you have to trust your email provider to not lose your mails. This is not something impossible while not very common. With OfflineIMAP, you can download your Mailboxes and make you own backups of the Maildir.

This allows reading your email while offline without the need for the mail reader (MUA) to support IMAP disconnected operations. Need an attachment from a message without internet connection? It's fine, 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 a software in development that I intend to replace OfflineIMAP in the long term.

That's why I'm not going to do development in OfflineIMAP. I continue to do the maintenance job in OfflineIMAP: fixing small bugs, (quick) reviewing/merging patches and rolling out new releases, but that's all.

While I keep tracking issues for OfflineIMAP, you should not expect support much from me anymore.

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.

The community

Requirements

  • Python v2.7
  • Python SQlite (optional while recommended)
  • Python json and urllib (used for XOAuth2 authentication)

Documentation

All the current and updated documentation is at 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
$ make api   # Requires sphinx