FairEmail/README.md

213 lines
9.7 KiB
Markdown
Raw Normal View History

2020-03-17 17:20:59 +00:00
<img src="https://github.com/M66B/FairEmail/raw/master/images/banner7_long.png" />
2019-07-29 07:35:38 +00:00
<p align="center">
<a href="#downloads">Downloads</a> &bull;
<a href="#privacy">Privacy</a> &bull;
<a href="#support">Support</a> &bull;
<a href="#license">License</a>
</p>
2019-07-12 15:26:32 +00:00
<img align="right" src="https://raw.githubusercontent.com/M66B/FairEmail/master/app/src/main/res/mipmap-hdpi/ic_launcher.png">
2019-05-15 20:44:21 +00:00
2018-09-17 07:09:35 +00:00
# FairEmail
2018-08-02 13:33:06 +00:00
2019-07-12 15:26:32 +00:00
![GitHub](https://img.shields.io/github/license/M66B/FairEmail.svg)
![GitHub release](https://img.shields.io/github/release/M66B/FairEmail.svg)
![GitHub commits since tagged version](https://img.shields.io/github/commits-since/M66B/FairEmail/0.1.svg)
2019-05-15 20:44:21 +00:00
2019-10-24 10:21:51 +00:00
*Fully featured, open source, privacy oriented email app for Android*
2018-08-02 13:33:06 +00:00
2019-10-24 08:00:45 +00:00
FairEmail is easy to setup and works with virtually all email providers, including Gmail, Outlook and Yahoo!
2019-10-23 15:18:51 +00:00
FairEmail might be for you if you value your privacy.
2018-09-22 10:11:13 +00:00
2019-11-23 15:45:39 +00:00
*FairEmail does not support non-standard protocols, like Microsoft Exchange Web Services and Microsoft ActiveSync.*
2018-11-09 10:58:52 +00:00
## Main features
2018-08-02 13:33:06 +00:00
2019-10-23 15:18:51 +00:00
* Fully featured
2019-07-12 15:26:32 +00:00
* 100 % [open source](https://github.com/M66B/FairEmail/blob/master/LICENSE)
2019-10-24 10:21:51 +00:00
* [Privacy oriented](https://github.com/M66B/FairEmail/blob/master/PRIVACY.md)
* Unlimited accounts
* Unlimited email addresses
2018-08-02 13:33:06 +00:00
* Unified inbox
2019-10-24 10:21:51 +00:00
* [Conversation threading](https://en.wikipedia.org/wiki/Conversation_threading)
2018-08-02 13:33:06 +00:00
* Two way synchronization
* Offline storage and operations
2018-09-22 16:09:59 +00:00
* Battery friendly
* Low data usage
2020-06-14 12:24:22 +00:00
* Small (< 15 MB)
2019-10-24 10:21:51 +00:00
* Material design (including dark/black theme)
2019-03-12 16:12:41 +00:00
* Maintained and supported
2018-08-02 13:33:06 +00:00
2019-12-13 08:57:36 +00:00
This app is deliberately minimalistic by design, so you can concentrate on reading and writing messages.
2019-08-12 08:31:32 +00:00
2019-08-21 06:01:14 +00:00
This app starts a foreground service with a low priority status bar notification to make sure you'll never miss new emails.
2019-08-12 08:31:32 +00:00
2019-07-02 09:44:54 +00:00
## Privacy features
2019-12-06 13:34:56 +00:00
* Encryption/decryption supported ([OpenPGP](https://www.openpgp.org/) and [S/MIME](https://en.wikipedia.org/wiki/S/MIME))
2019-07-08 18:20:17 +00:00
* Reformat messages to prevent [phishing](https://en.wikipedia.org/wiki/Phishing)
2019-07-02 09:44:54 +00:00
* Confirm showing images to prevent tracking
* Confirm opening links to prevent tracking and phishing
* Automatically recognize and disable tracking images
2019-07-12 15:26:32 +00:00
* Warning if messages could not be [authenticated](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq92)
2019-07-02 09:44:54 +00:00
2018-09-17 07:09:35 +00:00
## Simple
2018-08-02 13:33:06 +00:00
2018-12-31 07:55:54 +00:00
* Quick setup
2018-08-02 13:33:06 +00:00
* Easy navigation
* No bells and whistles
2019-03-30 17:57:58 +00:00
* No distracting "eye candy"
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## Secure
2018-08-02 13:33:06 +00:00
2019-01-08 09:35:33 +00:00
* No data storage on third party servers
2019-12-06 13:34:56 +00:00
* Using open standards (IMAP, SMTP, OpenPGP, S/MIME, etc)
2018-09-14 12:12:19 +00:00
* Safe message view (styling, scripting and unsafe HTML removed)
2018-11-11 10:08:57 +00:00
* Confirm opening links, images and attachments
2018-08-02 13:33:06 +00:00
* No special permissions required
* No advertisements
2019-07-28 07:25:29 +00:00
* No analytics and no tracking ([error reporting](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq104) is opt-in)
2018-11-11 08:15:15 +00:00
* No [Google backup](https://developer.android.com/guide/topics/data/backup)
2019-01-10 11:32:17 +00:00
* FairEmail is an original work, not a fork or a clone
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## Efficient
2018-08-02 13:33:06 +00:00
2019-10-24 08:57:46 +00:00
* Fast and lightweight
2018-09-03 09:42:59 +00:00
* [IMAP IDLE](https://en.wikipedia.org/wiki/IMAP_IDLE) (push messages) supported
2018-08-03 04:21:42 +00:00
* Built with latest development tools and libraries
2018-08-02 13:33:06 +00:00
2019-10-24 08:57:46 +00:00
## Pro features
All pro features are convenience or advanced features.
2019-12-28 11:34:42 +00:00
* Account/identity/folder colors
2019-10-24 08:57:46 +00:00
* Colored stars ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq107))
2020-01-29 20:44:53 +00:00
* Notification settings (sounds) per account/folder/sender (requires Android 8 Oreo) ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq145))
2019-10-24 08:57:46 +00:00
* Configurable notification actions
* Snooze messages ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq67))
* Send messages after selected time
* Synchronization scheduling ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq78))
* Reply templates
* Accept/decline calendar invitations
2020-05-21 06:56:08 +00:00
* Add message to calendar
2019-10-24 08:57:46 +00:00
* Filter rules ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq71))
2020-01-16 17:21:03 +00:00
* Search indexing, search on server ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq13))
2019-10-24 08:57:46 +00:00
* Keyword management
2020-01-17 10:32:54 +00:00
* S/MIME sign/encrypt ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq12))
2020-01-24 16:45:19 +00:00
* Biometric/PIN authentication ([instructions](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq113))
2019-10-24 08:57:46 +00:00
* Unified inbox widget
* Export settings
2018-11-09 13:50:48 +00:00
## Screenshots
2019-01-13 11:45:01 +00:00
Please see [here](https://email.faircode.eu/#screenshots) for screenshots.
2018-11-09 13:50:48 +00:00
2018-09-17 07:09:35 +00:00
## Downloads
2018-08-04 09:47:23 +00:00
2020-05-19 11:49:48 +00:00
Supported download locations:
2020-04-19 17:42:07 +00:00
* [GitHub](https://github.com/M66B/FairEmail/releases)
* [Play store](https://play.google.com/store/apps/details?id=eu.faircode.email)
2020-01-16 10:37:27 +00:00
* ~~[Play store](https://play.google.com/apps/testing/eu.faircode.email) (test)~~
2020-03-18 21:29:07 +00:00
* [F-Droid](https://f-droid.org/en/packages/eu.faircode.email/) ([last build status](https://f-droid.org/wiki/page/eu.faircode.email/lastbuild)) (the F-Droid app can be downloaded [here](https://f-droid.org/))
2020-04-07 15:35:02 +00:00
* ~~[AppGallery](https://wap3.hispace.hicloud.com/uowap/index.jsp#/detailApp/C101678151) (the AppGallery app can be downloaded [here](https://huaweimobileservices.com/appgallery/))~~
2018-08-04 09:47:23 +00:00
2020-03-19 10:17:06 +00:00
**Important**: after enrolling in the [Advanced Protection Program](https://landing.google.com/advancedprotection/) downloading/installing is possible from the Play store only.
2020-03-18 21:29:07 +00:00
2020-03-19 10:17:06 +00:00
The Gmail quick setup wizard can be used in official releases only (Play store or GitHub) because Google approved the use of OAuth for one app signature only.
2020-03-18 21:29:07 +00:00
**Important**: Gsuite accounts authorized with a username/password will stop working
2020-05-04 11:43:06 +00:00
[in the near future](https://gsuiteupdates.googleblog.com/2019/12/less-secure-apps-oauth-google-username-password-incorrect.html).
2020-03-18 21:29:07 +00:00
Gsuite accounts authorized with the quick setup wizard (OAuth) will keep working.
2019-07-24 11:10:01 +00:00
To download a GitHub release you might need to expand the assets section to download the [APK file](https://en.wikipedia.org/wiki/Android_application_package).
2019-06-23 18:42:13 +00:00
The GitHub version is being updated more often than the Play store version.
2020-03-18 21:29:07 +00:00
The GitHub release will automatically check for updates on GitHub (this can be turned off in the miscellaneous settings).
F-Droid builds new versions irregularly and you'll need the F-Droid client to get update notifications.
To get updates in a timely fashion you are advised to use the GitHub release.
Because F-Droid builds and GitHub releases are signed differently, an F-Droid build needs to be uninstalled first to be able to update to a GitHub release.
2019-06-23 18:42:13 +00:00
2018-10-26 11:15:48 +00:00
Certificate fingerprints:
2019-01-13 16:41:04 +00:00
```
MD5: 64:90:8E:2C:0D:25:29:B0:D0:26:2D:24:D8:BB:66:56
SHA1: 17:BA:15:C1:AF:55:D9:25:F9:8B:99:CE:A4:37:5D:4C:DF:4C:17:4B
SHA256: E0:20:67:24:9F:5A:35:0E:0E:C7:03:FE:9D:F4:DD:68:2E:02:91:A0:9F:0C:2E:04:10:50:BB:E7:C0:64:F5:C9
```
One line command to display certificate fingerprints:
```unzip -p fairemail.apk META-INF/CERT.RSA | keytool -printcert```
2018-10-26 11:15:48 +00:00
2019-07-29 17:20:54 +00:00
I do not hand over the signing keys of my apps to Google.
2018-10-10 09:23:24 +00:00
## Compatibility
2018-12-10 08:19:02 +00:00
FairEmail requires at least Android 5 Lollipop.
2020-01-08 13:04:21 +00:00
Individual message notifications are available on Android 7 Nougat and later only
because earlier Android versions do not support notification grouping.
2018-10-10 09:23:24 +00:00
2020-01-08 13:04:21 +00:00
Notification settings (sounds) per account/folder/sender are available on Android 8 Oreo and later only
because earlier Android versions do not support notification channels.
2018-11-08 06:47:38 +00:00
FairEmail will work properly on devices without any Google service installed.
2020-05-04 11:43:06 +00:00
Please see [here](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-known-problems) for known problems.
2018-11-16 15:08:01 +00:00
2020-01-08 13:04:21 +00:00
## Privacy
Please see [here](https://github.com/M66B/FairEmail/blob/master/PRIVACY.md#fairemail) for the privacy policy.
2019-07-29 07:35:38 +00:00
## Support
2018-08-02 13:33:06 +00:00
2020-05-04 11:43:06 +00:00
Please see [here](https://github.com/M66B/FairEmail/blob/master/FAQ.md) for a list of often asked questions and about how to get support.
2018-10-30 17:31:55 +00:00
2018-09-17 07:09:35 +00:00
## Contributing
2018-08-02 13:33:06 +00:00
*Documentation*
Contributions to this document and the frequently asked questions
are preferred in the form of [pull requests](https://help.github.com/articles/creating-a-pull-request/).
*Translations*
2019-07-12 16:20:47 +00:00
* You can translate the in-app texts of FairEmail [on Crowdin](https://crowdin.com/project/open-source-email)
2018-11-10 19:56:36 +00:00
* If your language is not listed, please send a message through [this contact form](https://contact.faircode.eu/?product=other)
2018-08-02 13:33:06 +00:00
*Source code*
2018-08-14 05:53:24 +00:00
Building FairEmail from source code is straightforward with [Android Studio](http://developer.android.com/sdk/).
2018-08-02 13:33:06 +00:00
It is expected that you can solve build problems yourself, so there is no support on building.
Source code contributions are preferred in the form of [pull requests](https://help.github.com/articles/creating-a-pull-request/).
2018-11-10 19:56:36 +00:00
Please [contact me](https://contact.faircode.eu/?product=other) first to tell me what your plans are.
2018-08-02 13:33:06 +00:00
2019-08-25 08:14:50 +00:00
Please note that by contributing you agree to the license below, including the copyright, without any additional terms or conditions.
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## Attribution
2018-08-02 13:33:06 +00:00
2019-07-23 14:59:12 +00:00
See [here](https://github.com/M66B/FairEmail/blob/master/ATTRIBUTION.md) for a list of used libraries and associated license information.
2018-08-02 13:33:06 +00:00
2019-05-18 09:19:39 +00:00
Error reporting is sponsored by:
2019-05-11 06:00:27 +00:00
![Bugsnag Logo](/images/bugsnag_logo_navy.png)
[Bugsnag](https://www.bugsnag.com/) monitors application stability
2019-07-12 15:26:32 +00:00
and is used to [help improve FairEmail](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq104).
2019-05-11 06:00:27 +00:00
2018-09-17 07:09:35 +00:00
## License
2018-08-02 13:33:06 +00:00
2020-01-05 17:32:53 +00:00
Copyright &copy; 2018-2020 Marcel Bokhorst. All rights reserved.
2018-08-02 13:33:06 +00:00
2019-07-29 07:35:38 +00:00
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl.txt)
2018-08-02 13:33:06 +00:00
2019-07-29 07:35:38 +00:00
> FairEmail is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
2018-08-02 13:33:06 +00:00
2019-07-29 07:35:38 +00:00
> FairEmail is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.