Go to file
Nicolas Sebrecht f46f08ecf8 README: deep cleanup
Documentation refactorized.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 15:52:46 +01:00
bin Convert to use OptionParser for command line handling. 2010-12-15 20:02:27 +01:00
docs doc: move all sources to the same directory 2015-03-10 15:52:46 +01:00
offlineimap fix: don't loose local mails because of maxage 2015-03-09 10:31:54 +01:00
test Refactoring: make functions to be private if we can 2014-04-30 19:35:56 +04:00
.gitignore allow fetching the website in our git work tree 2015-03-10 04:00:03 +01:00
Changelog.maint.rst v6.3.2.1 2011-03-16 20:46:18 +01:00
Changelog.rst Changelog: prepare for coming updates 2015-01-18 21:45:15 +01:00
CONTRIBUTING.rst docs: GitAdvanced: write the "sending pull request" section 2015-03-07 20:05:17 +01:00
COPYING COPYING: fix unexpected characters 2015-01-15 11:41:35 +01:00
get-website.sh allow fetching the website in our git work tree 2015-03-10 04:00:03 +01:00
MAINTAINERS.rst rework documentation 2015-03-07 19:26:17 +01:00
Makefile documentation: Make top-level README a plain text file. 2012-02-24 14:46:14 +01:00
MANIFEST.in Properly generate package via "sdist" 2014-11-26 23:17:43 +03:00
offlineimap.conf add proxy support powered by PySocks 2015-02-17 10:34:20 +01:00
offlineimap.conf.minimal Improve nametrans user documentation 2012-02-13 16:07:33 +01:00
offlineimap.py Add friendly message about Python 3.x being unsupported 2014-05-23 21:50:46 +04:00
README.md README: deep cleanup 2015-03-10 15:52:46 +01:00
setup.py Add offlineimap.utils to the list of our modules 2013-02-05 07:38:11 +04:00
TODO.rst add TODO.rst 2015-03-07 19:56:05 +01:00

OfflineImap

Description

OfflineIMAP is a software to dispose your e-mail mailbox(es) as a local Maildir.

For example, this allows reading the mails while offline without the need for your mail reader (MUA) to support disconnected operations.

OfflineIMAP will synchronize both sides via IMAP.

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 package OfflineIMAP for you. Downloads releases as tarball or zipball.

Feedbacks and contributions

The user discussions, development, announces and all the exciting stuff take place in 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)

Documentation

The documentation is included (in .rst format) in the docs directory. Read it directly or generate nice html docs (python-sphinx needed) and/or the man page (python-docutils needed) while being in the docs dir via:

'make doc' (user docs), 'make man' (man page only) or 'make' (both)

(`make html` will simply create html versions of all *.rst files in /docs)

The resulting user documentation will be in docs/html. The full user docs are also at: http://docs.offlineimap.org. Please see there for detailed information on how to install and configure OfflineImap.