PIM
/
offlineimap
mirror of https://github.com/OfflineIMAP/offlineimap.git
1
0
Fork 0
Code Issues Releases Wiki Activity
2,122 Commits 4 Branches 149 Tags 7.1 MiB
Python 97.6%
Shell 2%
Makefile 0.4%
Go to file
Nicolas Sebrecht feef2b4af2 explain how to submit issues in more files 
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
 		2016-09-09 21:10:30 +02:00
.github github template: add system/distribution 2016-07-28 18:47:36 +02:00
bin Convert to use OptionParser for command line handling. 2010-12-15 20:02:27 +01:00
contrib release.sh: minor enhancements 2016-08-13 18:11:03 +02:00
docs manual: add known issue about netrc 2016-07-28 04:18:18 +02:00
offlineimap mbnames: add info output messages in dry run mode 2016-08-26 01:44:15 +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
CODE_OF_CONDUCT.md code of conduct: try to clarify what item 3 might mean 2016-07-12 16:04:55 +02:00
CONTRIBUTING.rst explain how to submit issues in more files 2016-09-09 21:10:30 +02:00
COPYING COPYING: fix unexpected characters 2015-01-15 11:41:35 +01:00
Changelog.maint.md v6.7.0.3 2016-07-26 08:46:22 +02:00
Changelog.md v7.0.6 2016-08-21 20:43:03 +02:00
MAINTAINERS.rst MAINTAINERS: update 2016-02-27 20:10:34 +01:00
MANIFEST.in MANIFEST: exclude rfcs 2016-02-27 05:25:09 +01:00
Makefile Really execute the recipe of the 'docs' target in top-most Makefile 2016-03-21 18:41:41 +01:00
README.md explain how to submit issues in more files 2016-09-09 21:10:30 +02:00
TODO.rst update TODO.rst 2015-11-23 02:24:33 +01:00
offlineimap.conf offlineimap.conf: add note about Gmail\All Mail keeping the emails while deleted 2016-08-14 22:49:32 +02:00
offlineimap.conf.minimal Improve nametrans user documentation 2012-02-13 16:09:32 +01:00
offlineimap.py allow to run under python3 without special env 2016-06-03 19:59:56 +02:00
requirements.txt move requirements.txt to the root directory 2016-06-07 17:05:31 +02: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

README.md

OfflineIMAP

"Get the emails where you need them."

Official 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 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. 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 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 (http://asciidoc.org)
$ make api   # Requires sphinx