2018-03-06 22:15:37 +01:00
2019-12-15 20:13:46 +01:00
Financial contributors: [![Financial Contributors on Open Collective ](https://opencollective.com/offlineimap-organization/all/badge.svg?label=financial+contributors )](https://opencollective.com/offlineimap-organization)
2015-10-14 00:09:40 +02:00
[offlineimap]: http://github.com/OfflineIMAP/offlineimap
2020-09-05 01:23:07 +02:00
[offlineimap3]: http://github.com/OfflineIMAP/offlineimap3
2016-02-19 12:10:23 +01:00
[website]: http://www.offlineimap.org
2015-03-10 04:01:22 +01:00
[wiki]: http://github.com/OfflineIMAP/offlineimap/wiki
2016-02-19 12:10:23 +01:00
[blog]: http://www.offlineimap.org/posts.html
2011-01-15 16:48:30 +01:00
2018-03-04 22:35:41 +01:00
Links:
* Official github code repository: [offlineimap]
* Website: [website]
* Wiki: [wiki]
* Blog: [blog]
2015-09-24 17:45:30 +02:00
# OfflineIMAP
2011-01-15 16:48:30 +01:00
2016-05-19 09:49:53 +02:00
***"Get the emails where you need them."***
2016-03-02 15:36:22 +01:00
2021-08-03 00:55:07 +02:00
> The offlineimap project is about python2 oonly. The support for offlineimap3
> is happening in [Official offlineimap for python3][offlineimap3].
>
> I'll still lazily maintain offlineimap but users should definitely go with
> offlineimap3.
- [Official offlineimap for python3][offlineimap3].
- [Official offlineimap for python2][offlineimap].
2016-08-03 00:01:17 +02:00
2016-07-18 16:11:17 +02:00
2015-03-10 04:01:22 +01:00
## Description
2011-01-15 16:48:30 +01:00
2016-07-18 16:11:17 +02:00
OfflineIMAP is software that downloads your email mailbox(es) as **local
Maildirs**. OfflineIMAP will synchronize both sides via *IMAP* .
2011-01-15 16:48:30 +01:00
2017-04-16 01:02:52 +02:00
## Why should I use OfflineIMAP?
2016-07-18 16:11:17 +02:00
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.
2015-03-12 17:53:28 +01:00
With OfflineIMAP, you can download your Mailboxes and make you own backups of
2016-07-18 16:11:17 +02:00
your [Maildir ](https://en.wikipedia.org/wiki/Maildir ).
2011-01-15 16:48:30 +01:00
2016-07-18 16:11:17 +02:00
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.
2012-02-24 11:13:27 +01:00
2011-01-15 16:48:30 +01:00
2015-10-14 00:09:40 +02:00
## Project status and future
2020-09-05 01:23:07 +02:00
The [offlineimap][offlineimap] project was forked to
[offlineimap3][offlineimap3] to support python3. Contributions are welcome to
this project.
2015-10-14 00:09:40 +02:00
2016-03-02 15:36:22 +01:00
2019-12-15 19:00:59 +01:00
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
< a href = "https://github.com/OfflineIMAP/offlineimap/graphs/contributors" > < img src = "https://opencollective.com/offlineimap-organization/contributors.svg?width=890&button=false" / > < / a >
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute ](https://opencollective.com/offlineimap-organization/contribute )]
#### Individuals
< a href = "https://opencollective.com/offlineimap-organization" > < img src = "https://opencollective.com/offlineimap-organization/individuals.svg?width=890" > < / a >
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute ](https://opencollective.com/offlineimap-organization/contribute )]
< a href = "https://opencollective.com/offlineimap-organization/organization/0/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/1/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/2/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/3/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/4/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/5/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/6/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/7/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/8/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/offlineimap-organization/organization/9/website" > < img src = "https://opencollective.com/offlineimap-organization/organization/9/avatar.svg" > < / a >
2016-03-02 15:36:22 +01:00
## License
GNU General Public License v2.
2015-03-10 04:01:22 +01:00
## Downloads
2011-01-15 16:48:30 +01:00
2015-09-24 17:51:01 +02:00
You should first check if your distribution already packages OfflineIMAP for you.
2015-03-10 04:01:22 +01:00
Downloads releases as [tarball or zipball ](https://github.com/OfflineIMAP/offlineimap/tags ).
2011-01-15 16:48:30 +01:00
2019-08-17 12:16:09 +02:00
If you are running Linux Os, you can install offlineimap with:
- openSUSE `zypper in offlineimap`
2019-12-16 18:24:15 +01:00
- Arch Linux `pacman -S offlineimap`
2019-08-17 12:16:09 +02:00
- fedora `dnf install offlineimap`
2011-01-15 16:48:30 +01:00
2015-03-10 04:01:22 +01:00
## Feedbacks and contributions
2011-01-15 16:48:30 +01:00
2015-09-24 17:51:01 +02:00
**The user discussions, development, announcements and all the exciting stuff take
place on the mailing list.** While not mandatory to send emails, you can
2015-03-10 16:49:53 +01:00
[subscribe here ](http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project ).
2011-01-15 16:48:30 +01:00
2015-03-10 04:01:22 +01:00
Bugs, issues and contributions can be requested to both the mailing list or the
2016-09-09 21:10:30 +02:00
[official Github project][offlineimap]. 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
2011-01-15 16:48:30 +01:00
2015-03-10 04:01:22 +01:00
## The community
2011-01-15 16:48:30 +01:00
2015-03-10 04:01:22 +01:00
* OfflineIMAP's main site is the [project page at Github][offlineimap].
* There is the [OfflineIMAP community's website][website].
* And finally, [the wiki][wiki].
2011-01-15 16:48:30 +01:00
2016-06-17 02:21:16 +02:00
## Requirements & dependencies
2011-01-15 16:48:30 +01:00
2021-05-18 14:07:55 +02:00
* Python v2.7.x
2016-05-19 09:49:53 +02:00
* six (required)
2019-06-10 14:36:00 +02:00
* rfc6555 (required)
2017-03-23 18:36:45 +01:00
* imaplib2 >= 2.57 (optional)
2018-03-02 16:37:43 +01:00
* gssapi (optional), for Kerberos authentication
2019-04-27 14:51:41 +02:00
* portalocker (optional), if you need to run offlineimap in Cygwin for Windows
2011-01-15 16:48:30 +01:00
2020-09-05 01:23:07 +02:00
* Python v3: See the [offlineimap3][offlineimap3] fork of
[offlineimap][offlineimap].
2019-06-10 14:36:00 +02:00
2015-03-10 04:01:22 +01:00
## Documentation
2011-01-15 16:48:30 +01:00
2016-07-18 16:11:17 +02:00
All current and updated documentation is on the [community's website][website].
2015-03-13 19:10:48 +01:00
2015-09-24 17:51:01 +02:00
### Read documentation locally
2015-03-13 19:10:48 +01:00
2015-09-24 17:51:01 +02:00
You might want to read the documentation locally. Get the sources of the website.
For the other documentation, run the appropriate make target:
2016-07-18 16:11:17 +02:00
```sh
2015-03-13 19:10:48 +01:00
$ ./scripts/get-repository.sh website
$ cd docs
2015-09-24 17:51:01 +02:00
$ make html # Requires rst2html
2016-08-28 14:24:37 +02:00
$ make man # Requires a2x (http://asciidoc.org)
2015-09-24 17:51:01 +02:00
$ make api # Requires sphinx
2015-03-13 19:10:48 +01:00
```