Read/sync your IMAP mailboxes (python3) https://www.offlineimap.org/

Rodolfo García Peñas (kix) db34745227 Merge pull request #154 from keithbowes/extra-search-paths 2 months ago
.github 514744a0eb remove requests for reviews in github 4 years ago
bin 914486e0d9 Changed environment to python3 in offlineimap 4 years ago
contrib 093f3685d1 Included contrib nametrans_imap_to_utf8.py 4 years ago
docs 6ef5937a5c docs/website-doc.sh: minor improvements in comments of versions.yml 6 years ago
offlineimap db34745227 Merge pull request #154 from keithbowes/extra-search-paths 2 months ago
scripts 23b497d191 scripts/get-repository.sh.rej: remove unused file 7 years ago
test 27351d9e90 Test global calls AttributeError 4 years ago
tests fc52034ea8 Autmomated testing using Travis and CodeCov.io! 6 years ago
.coveragerc fc52034ea8 Autmomated testing using Travis and CodeCov.io! 6 years ago
.gitignore 4f5b2529e4 Full packaging review 2 months ago
.travis.yml 8406ba3bb4 travis: remove python3.6 5 years ago
BACKERS.md c8c023e706 Create BACKERS.md (#145) 1 year ago
CODE_OF_CONDUCT.md 3be01d2142 code of conduct: try to clarify what item 3 might mean 8 years ago
CONTRIBUTING.rst feef2b4af2 explain how to submit issues in more files 8 years ago
COPYING c5eb4c9432 COPYING: fix unexpected characters 9 years ago
Changelog.maint.md ecef22a16c v6.7.0.3 8 years ago
Changelog.md 557ca854c2 v8.0.0 3 years ago
Dockerfile 769f7ce218 start work on dockerfile 3 years ago
MAINTAINERS.rst f5b0b829da Updated MAINTAINERS.rst and README.md 3 years ago
MANIFEST.in 543890e257 MANIFEST: exclude rfcs 8 years ago
Makefile 0ad8bb25ad Makefile: targz: don't set the abbrev in the archive directory name 6 years ago
README.md 0c2433c5c1 Add FreeBSD pkg search/install to install examples 2 months ago
TODO.rst 573d55827f update TODO.rst 9 years ago
offlineimap.conf 7748de52fb Communicate syncmode to synchooks 3 years ago
offlineimap.conf.minimal f5b82ad76d Improve nametrans user documentation 12 years ago
offlineimap.py f576181ae1 offlineimap.py using env python3 4 years ago
pyproject.toml 4f5b2529e4 Full packaging review 2 months ago
requirements-certify.txt 4f5b2529e4 Full packaging review 2 months ago
requirements-cygwin.txt 4f5b2529e4 Full packaging review 2 months ago
requirements-kerberos.txt 4f5b2529e4 Full packaging review 2 months ago
requirements-keyring.txt 4f5b2529e4 Full packaging review 2 months ago
requirements.txt 4f5b2529e4 Full packaging review 2 months ago
setup.cfg 0c0f51db13 Use an underscore rather than a dash in setup.cfg 2 months ago
setup.py 4f5b2529e4 Full packaging review 2 months ago
snapcraft.yaml 73164658b2 snapcraft uses python3 4 years 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."

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

OfflineIMAP, using Python 3, is based on OfflineIMAP for Python 2. Currently we are updating the source code. These changes should not affect the user (documentation, configuration files,... are the same) but some links or packages could refer to the Python 2 version. In that case, please open an issue.

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/BSD, you can install offlineimap with:

  • Debian and Ubuntu apt install offlineimap3
  • openSUSE zypper install offlineimap
  • Fedora dnf install offlineimap
  • FreeBSD pkg search offlineimap3, and install the python versioned package, pkg install py311-offlineimap3
  • Arch Linux: pacman -S offlineimap, or through AUR package offlineimap3-git
  • Docker image: offlineimap/offlineimap:latest (note: image not published yet, just an example)

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

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