"Get the emails where you need them."
-# OfflineIMAP - -***"Get the emails where you need them."*** +
+ Website • + Documetation • + Wiki • + Blog +
## Description -OfflineIMAP is software that downloads your email mailbox(es) as **local -Maildirs**. OfflineIMAP will synchronize both sides via *IMAP*. +OfflineIMAP3 is software that downloads your email mailbox(es) as **local +Maildirs**. OfflineIMAP3 will synchronize both sides via *IMAP*. -## Why should I use OfflineIMAP? +## Why should I use OfflineIMAP3? 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 +With OfflineIMAP3, you can download your Mailboxes and make you own backups of your [Maildir](https://en.wikipedia.org/wiki/Maildir). This allows reading your email offline without the need for your mail @@ -45,60 +40,34 @@ 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.0 or later. - - -## Downloads - -You should first check if your distribution already packages OfflineIMAP for you. -Downloads releases as [tarball or zipball](https://github.com/OfflineIMAP/offlineimap3/tags). - -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`](https://archlinux.org/packages/extra/any/offlineimap/), or through AUR package [offlineimap3-git](https://aur.archlinux.org/packages/offlineimap3-git/) -- Docker image: `offlineimap/offlineimap:latest` - (note: image not published yet, just an example) - -## Feedbacks and contributions +This project, **OfflineIMAP3**, is a Python 3 port of the original [OfflineIMAP](https://github.com/OfflineIMAP/offlineimap) (Python 2). We are currently updating the source code to ensure full compatibility. While user-facing elements (documentation, configuration files, etc.) remain unchanged, some links or packages may still reference the Python 2 version. If you encounter any such references, please [open an issue](https://github.com/OfflineIMAP/offlineimap3/issues). -**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](http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project). -Bugs, issues and contributions can be requested to both the mailing list or the -[official Github project][offlineimap3]. 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 +## Installation +### Option A: Install from Source (Tarball/Zipball) +Download a release from [GitHub tags](https://github.com/OfflineIMAP/offlineimap3/tags), then: +```bash +tar -xzf offlineimap3-*.tar.gz +cd offlineimap3-* +pip install . +``` -## The community +### Option B: Install via Package Manager +Check if your distribution provides a package for OfflineIMAP3. If available, use one of the following commands: -* OfflineIMAP's main site is the [project page at Github][offlineimap3]. -* There is the [OfflineIMAP community's website][website]. -* And finally, [the wiki][wiki]. +- **Debian/Ubuntu:** `sudo apt install offlineimap3` +- **openSUSE:** `sudo zypper install offlineimap` +- **Fedora:** `sudo dnf install offlineimap` +- **FreeBSD:** `pkg search offlineimap3`, then `sudo pkg install py311-offlineimap3` +- **Arch Linux:** `sudo pacman -S offlineimap` (or AUR: [offlineimap3-git](https://aur.archlinux.org/packages/offlineimap3-git/)) +- **MacOS:** `brew install offlineimap` + -## Requirements & dependencies +### Requirements & dependencies * Python v3.6+ * rfc6555 (required) @@ -110,10 +79,6 @@ Bugs, issues and contributions can be requested to both the mailing list or the * certify (optional), for Internet SSL certificate validation * urllib3 (optional), for Internet SSL certificate validation -## Documentation - -All current and updated documentation is on the [community's website][website]. - ### Read documentation locally @@ -127,3 +92,32 @@ $ make html # Requires rst2html $ make man # Requires a2x (http://asciidoc.org) $ make api # Requires sphinx ``` + +## Feedbacks + +Bugs, issues and contributions can be requested to both the mailing list or the +[official Github project](https://github.com/OfflineIMAP/offlineimap3). 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 + + +## Contributing + +Pull requests are welcome! For details on the development workflow and coding guidelines, please refer to: +- [Development Workflow](https://www.offlineimap.org/doc/GitAdvanced.html) +- [Coding Guidelines](https://www.offlineimap.org/doc/CodingGuidelines.html) + +**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](http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project). + + +## License + +This project is licensed under the **GNU General Public License v2.0 or later**. +See the [LICENSE](https://github.com/lb803/offlineimap3/blob/master/COPYING) file for details.