"Get the emails where you need them."
Links:
- Official (upstream) github code repository
- Website
- Wiki
- Blog
- Subscribe to the Mailing List
- Read/Search the Mailing List Archive
- OfflineIMAP is software that downloads your email mailbox(es) as local Maildirs.
- OfflineIMAP will synchronize mailboxes between two mail servers via IMAP.
- Most up to date Change Log.
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.
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. ,-)
GNU General Public License v2.
- You should first check if your distribution already packages OfflineIMAP for you, most Linux have it.
- On MacOSX thru Homebrew, MacPorts, and others.
- Downloads releases as tarball or zipball.
- You can easily Install as a Snap
sudo snap install offlineimap
The configuration file for offlineimap should be placed in$HOME/snap/offlineimap/current/.offlineimaprc
(Don't have snapd installed?) Example minimal conf file, and conf file with all options described in full.
-
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 to the Mailing List here, and read/search the Mailing List Archive.
-
Bugs, issues and contributions can be requested to both the mailing list or the official Github project. Open a new issue, and 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
- Have a look at the "To Do" list, and the "need contributor!" issues, then, contribute your code to solve the issue by opening a pull request.
- Remeber to heed the Code of Conduct.
- OfflineIMAP's main site is the project page at Github.
- There is the OfflineIMAP community's website.
- And finally, the wiki.
- Python v2.7+
- Python v3.4+ [STALLED](experimental: see known issues)
- six (required)
- imaplib2 >= 2.57 (optional)
- All current and updated documentation is on the community's website.
- The current Change Log.
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
Our current list of Maintainers.
OfflineIMAP exists thanks to all the people who contribute.
Thank you to all our backers! 🙏 Become a backer
Support OfflineIMAP by becoming a sponsor. Your logo will show up here with a link to your website.