FairEmail/README.md

178 lines
8.3 KiB
Markdown
Raw Normal View History

2018-09-17 07:09:35 +00:00
# FairEmail
2018-08-02 13:33:06 +00:00
2019-02-20 11:56:18 +00:00
*Open source, privacy friendly email app for Android*
2018-08-02 13:33:06 +00:00
2019-04-06 08:40:15 +00:00
This open source, privacy friendly email app might be for you if your current email app:
2018-08-02 13:33:06 +00:00
2019-01-26 10:04:33 +00:00
* takes long to receive or to show messages
2018-09-14 12:12:19 +00:00
* can manage only one email address
2019-01-26 10:04:33 +00:00
* cannot handle a large number of messages
2018-09-04 08:14:26 +00:00
* cannot show conversations
2018-08-02 13:33:06 +00:00
* cannot work offline
* looks outdated
* is not maintained
* stores your email on their servers
2018-08-02 13:33:06 +00:00
* is closed source, potentially violating your privacy
2018-09-22 10:11:13 +00:00
This app is minimalistic by design, so you can concentrate on reading and writing messages.
This app starts a foreground service with a low priority status bar notification to make sure you'll never miss new email.
2018-11-09 10:58:52 +00:00
## Main features
2018-08-02 13:33:06 +00:00
2018-11-04 19:04:08 +00:00
* 100 % [open source](https://github.com/M66B/open-source-email/blob/master/LICENSE)
2019-04-18 10:48:39 +00:00
* Multiple accounts
* Multiple email addresses
2018-08-02 13:33:06 +00:00
* Unified inbox
2018-11-04 19:04:08 +00:00
* Flat [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
2019-03-12 10:25:17 +00:00
* Small (~6 MB)
2018-08-02 13:33:06 +00:00
* Material design
2019-03-12 16:12:41 +00:00
* Maintained and supported
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## Pro features
2018-08-26 07:26:56 +00:00
2018-11-10 17:27:01 +00:00
* Account/identity colors
* Notifications per account (requires Android 8 Oreo or later)
2019-02-09 08:44:43 +00:00
* Notifications with message details (requires Android 7 Nougat or later)
2019-03-07 13:06:06 +00:00
* Notification sound per sender (requires Android 8 Oreo or later)
2019-02-18 19:39:44 +00:00
* Snooze messages ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq67))
2019-01-07 17:50:23 +00:00
* Send messages after selected time
2019-04-06 08:37:11 +00:00
* Synchronization scheduling ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq78))
2018-11-07 12:51:43 +00:00
* Reply templates
2019-02-18 17:29:49 +00:00
* Filter rules ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq71))
* Search on device or server ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq13))
2018-11-26 13:49:08 +00:00
* Keyword management
2019-02-18 17:29:49 +00:00
* Encryption/decryption ([OpenPGP](https://www.openpgp.org/)) ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq12))
2018-09-14 11:33:22 +00:00
* Export settings
2018-08-26 07:26:56 +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
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
* No analytics and no tracking
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
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
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
2018-09-09 05:50:10 +00:00
* [GitHub](https://github.com/M66B/open-source-email/releases)
2018-08-23 14:04:50 +00:00
* [Play store](https://play.google.com/apps/testing/eu.faircode.email)
2018-08-04 09:47:23 +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-04-20 15:30:51 +00:00
* [F-Droid](https://f-droid.org/en/packages/eu.faircode.email/)
2019-04-23 18:11:21 +00:00
Note that F-Droid builds new versions irregularly.
To get updates in a timely fashion you are advised to use the GitHub release.
The GitHib release will automatically check for updates on GitHub.
You can turn this off in the advanced options.
2019-01-13 11:45:01 +00:00
## Privacy
2019-01-13 13:00:48 +00:00
Please see [here](https://github.com/M66B/open-source-email/blob/master/PRIVACY.md#fairemail) for the privacy policy.
2019-01-13 11:45:01 +00:00
2018-10-10 09:23:24 +00:00
## Compatibility
2018-12-10 08:19:02 +00:00
FairEmail requires at least Android 5 Lollipop.
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
2018-11-08 06:47:38 +00:00
FairEmail will work properly on devices without any Google service installed.
2018-11-16 15:08:01 +00:00
See [here](https://github.com/M66B/open-source-email/blob/master/FAQ.md#known-problems) for known problems.
2018-11-03 09:44:18 +00:00
## Support / frequently asked questions
2018-08-02 13:33:06 +00:00
2018-11-03 09:44:18 +00:00
See [here](https://github.com/M66B/open-source-email/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*
2018-11-10 19:56:36 +00:00
* You can translate the in-app texts of FairEmail [on Crowdin](https://crowdin.com/project/open-source-email)
* 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
Please note that you agree to the license below by contributing, including the copyright.
2018-09-17 07:09:35 +00:00
## Attribution
2018-08-02 13:33:06 +00:00
2018-08-14 05:53:24 +00:00
FairEmail uses:
2018-08-02 13:33:06 +00:00
2019-01-13 11:45:01 +00:00
* [JavaMail](https://projects.eclipse.org/projects/ee4j.javamail). Copyright (c) 1997-2018 Oracle® and/or its affiliates. All rights reserved. [GPLv2+CE license](https://javaee.github.io/javamail/JavaMail-License).
2018-08-02 13:33:06 +00:00
* [jsoup](https://jsoup.org/). Copyright © 2009 - 2017 Jonathan Hedley. [MIT license](https://jsoup.org/license).
* [Android Support Library](https://developer.android.com/tools/support-library/). Copyright (C) 2011 The Android Open Source Project. [Apache license](https://android.googlesource.com/platform/frameworks/support/+/master/LICENSE.txt).
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/). Copyright 2018 The Android Open Source Project, Inc. [Apache license](https://github.com/googlesamples/android-architecture-components/blob/master/LICENSE).
2018-09-18 05:35:40 +00:00
* [colorpicker](https://android.googlesource.com/platform/frameworks/opt/colorpicker). Copyright (C) 2013 The Android Open Source Project. [Apache license](https://android.googlesource.com/platform/frameworks/opt/colorpicker/+/master/src/com/android/colorpicker/ColorPickerDialog.java).
2018-09-18 14:22:10 +00:00
* [dnsjava](http://www.xbill.org/dnsjava/). Copyright (c) 1998-2011, Brian Wellington. [BSD License](https://sourceforge.net/p/dnsjava/code/HEAD/tree/trunk/LICENSE).
2018-10-29 07:58:22 +00:00
* [OpenPGP API library](https://github.com/open-keychain/openpgp-api). Copyright (C) 2014-2015 Dominik Schürmann. [Apache License 2.0](https://github.com/open-keychain/openpgp-api/blob/master/LICENSE).
2018-11-09 07:38:07 +00:00
* [Android SQLite support library](https://github.com/requery/sqlite-android). Copyright (C) 2017 requery.io. [Apache License 2.0](https://github.com/requery/sqlite-android/blob/master/LICENSE).
2018-11-07 17:18:08 +00:00
* [App shortcut icon generator](https://romannurik.github.io/AndroidAssetStudio/icons-app-shortcut.html). Copyright ???. [Apache License 2.0](https://github.com/romannurik/AndroidAssetStudio/blob/master/LICENSE).
2018-12-29 15:04:22 +00:00
* [Mozilla ISPDB](https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration#ISPDB). *Free to use for any client.*
2019-03-27 09:48:20 +00:00
* [ShortcutBadger](https://github.com/leolin310148/ShortcutBadger). Copyright 2014 Leo Lin. [Apache license](https://github.com/leolin310148/ShortcutBadger/blob/master/LICENSE).
2019-04-19 06:31:00 +00:00
* [PhotoView](https://github.com/chrisbanes/PhotoView). Copyright 2018 Chris Banes. [Apache License](https://github.com/chrisbanes/PhotoView/blob/master/LICENSE).
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## License
2018-08-02 13:33:06 +00:00
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl.txt)
2019-01-10 13:53:23 +00:00
Copyright © 2018-2019 Marcel Bokhorst. All rights reserved
2018-08-02 13:33:06 +00:00
2018-08-14 05:53:24 +00:00
FairEmail is free software: you can redistribute it and/or modify
2018-08-02 13:33:06 +00:00
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-14 05:53:24 +00:00
FairEmail is distributed in the hope that it will be useful,
2018-08-02 13:33:06 +00:00
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.
You should have received a copy of the GNU General Public License
2018-08-14 05:53:24 +00:00
along with FairEmail. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).