You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Nicolas Sebrecht ba4ecea9e4 v7.3.0 2 months ago
.github PULL_REQUEST_TEMPLATE: add space between brackets to enable the edition in the gui 8 months ago
bin bin/offlineimap: fix shebang to env python2 1 year ago
contrib contrib/release.py: don't break if sphinx-build is missing 8 months ago
docs docs/website-doc.sh: minor improvements in comments of versions.yml 1 year ago
offlineimap v7.3.0 2 months ago
scripts scripts/get-repository.sh.rej: remove unused file 2 years ago
test Autmomated testing using Travis and CodeCov.io! 1 year ago
tests Autmomated testing using Travis and CodeCov.io! 1 year ago
.coveragerc Autmomated testing using Travis and CodeCov.io! 1 year ago
.gitignore gitignore: re-introduce *.css 1 year ago
.travis.yml travis: remove python3.6 5 months ago
CODE_OF_CONDUCT.md code of conduct: try to clarify what item 3 might mean 3 years ago
CONTRIBUTING.rst explain how to submit issues in more files 3 years ago
COPYING COPYING: fix unexpected characters 4 years ago
Changelog.maint.md v6.7.0.3 3 years ago
Changelog.md v7.3.0 2 months ago
MAINTAINERS.rst Add self to maintainers. Update email address. 1 year ago
MANIFEST.in MANIFEST: exclude rfcs 3 years ago
Makefile Makefile: targz: don't set the abbrev in the archive directory name 1 year ago
README.md update readme to give an hint about Linux distros 2 months ago
TODO.rst update TODO.rst 4 years ago
offlineimap.conf offlineimap.conf: minor fixes 11 months ago
offlineimap.conf.minimal Improve nametrans user documentation 7 years ago
offlineimap.py Update FSF postal address. 7 months ago
requirements.txt implement Happy Eyeballs 5 months ago
setup.cfg pypi requires a setup.cfg when README is Markdown 3 years ago
setup.py Update FSF postal address. 7 months ago
snapcraft.yaml Initial commit of snapcraft.yaml 1 year ago

README.md

Upstream status (master branch): OfflineIMAP build status on Travis-CI.org OfflineIMAP code coverage on Codecov.io Gitter chat

Upstream status (next branch): OfflineIMAP build status on Travis-CI.org

Links:

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.

Why should I use OfflineIMAP?

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.

Downloads

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

If you are running Linux Os, you can install offlineimap with:

  • openSUSE zypper in offlineimap
  • archLinux pacman -S offlineimap
  • fedora dnf install offlineimap

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+
  • six (required)
  • rfc6555 (required)
  • imaplib2 >= 2.57 (optional)
  • gssapi (optional), for Kerberos authentication
  • portalocker (optional), if you need to run offlineimap in Cygwin for Windows

  • Python v3.4+ STALLED

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