docker-offlineimap/README.md
Nicolas Sebrecht 65274312a6 README: improve description
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-12 17:53:28 +01:00

2.3 KiB

OfflineImap

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 MAIL provider to not loose 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 mails while offline without the need for the mail reader (MUA) to support IMAP disconnected operations. Need an attachement from a message without internet? It's fine, the message is still there.

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.