mirror of https://github.com/M66B/FairEmail.git
212 lines
11 KiB
Markdown
212 lines
11 KiB
Markdown
<img align="right" src="https://raw.githubusercontent.com/M66B/open-source-email/master/app/src/main/res/mipmap-hdpi/ic_launcher.png">
|
|
|
|
# FairEmail
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*Open source, privacy friendly email app for Android*
|
|
|
|
This open source, privacy friendly email app might be for you if your current email app:
|
|
|
|
* takes long to receive or to show messages
|
|
* can manage only one email address
|
|
* cannot handle a large number of messages
|
|
* cannot show conversations
|
|
* cannot work offline
|
|
* looks outdated
|
|
* is not maintained and supported
|
|
* stores your email on their servers
|
|
* is closed source, potentially violating your privacy
|
|
|
|
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.
|
|
|
|
## Main features
|
|
|
|
* 100 % [open source](https://github.com/M66B/open-source-email/blob/master/LICENSE)
|
|
* [Privacy friendly](https://github.com/M66B/open-source-email/blob/master/PRIVACY.md)
|
|
* Multiple accounts
|
|
* Multiple email addresses
|
|
* Unified inbox
|
|
* Flat [conversation threading](https://en.wikipedia.org/wiki/Conversation_threading)
|
|
* Two way synchronization
|
|
* Offline storage and operations
|
|
* Battery friendly
|
|
* Low data usage
|
|
* Small (< 10 MB)
|
|
* Material design (including dark theme)
|
|
* Maintained and supported
|
|
|
|
## Privacy features
|
|
|
|
* Reformat messages to prevent [phishing](https://en.wikipedia.org/wiki/Phishing)
|
|
* Confirm showing images to prevent tracking
|
|
* Confirm opening links to prevent tracking and phishing
|
|
* Automatically recognize and disable tracking images
|
|
* Warn when a message could not be [authenticated](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq92)
|
|
|
|
## Pro features
|
|
|
|
All pro features are convenience or advanced features.
|
|
|
|
* Account/identity colors
|
|
* Colored stars ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq107))
|
|
* Notification settings (sounds) per account/folder/sender (requires Android 8 Oreo)
|
|
* Configurable notification actions
|
|
* Snooze messages ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq67))
|
|
* Send messages after selected time
|
|
* Synchronization scheduling ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq78))
|
|
* Reply templates
|
|
* Accept/decline calendar invitations
|
|
* 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))
|
|
* Keyword management
|
|
* Encryption/decryption ([OpenPGP](https://www.openpgp.org/)) ([instructions](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq12))
|
|
* Export settings
|
|
|
|
## Simple
|
|
|
|
* Quick setup
|
|
* Easy navigation
|
|
* No bells and whistles
|
|
* No distracting "eye candy"
|
|
|
|
## Secure
|
|
|
|
* No data storage on third party servers
|
|
* Safe message view (styling, scripting and unsafe HTML removed)
|
|
* Confirm opening links, images and attachments
|
|
* No special permissions required
|
|
* No advertisements
|
|
* No analytics and no tracking
|
|
* No [Google backup](https://developer.android.com/guide/topics/data/backup)
|
|
* FairEmail is an original work, not a fork or a clone
|
|
|
|
## Efficient
|
|
|
|
* [IMAP IDLE](https://en.wikipedia.org/wiki/IMAP_IDLE) (push messages) supported
|
|
* Built with latest development tools and libraries
|
|
|
|
## Screenshots
|
|
|
|
Please see [here](https://email.faircode.eu/#screenshots) for screenshots.
|
|
|
|
## Downloads
|
|
|
|
* [GitHub](https://github.com/M66B/open-source-email/releases)
|
|
* [Play store](https://play.google.com/store/apps/details?id=eu.faircode.email)
|
|
* [Play store](https://play.google.com/apps/testing/eu.faircode.email) (test)
|
|
|
|
The GitHub version is being updated more often than the Play store version.
|
|
The GitHub version will automatically notify you of any updates.
|
|
|
|
Certificate fingerprints:
|
|
|
|
```
|
|
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```
|
|
|
|
* [F-Droid](https://f-droid.org/en/packages/eu.faircode.email/) ([last build status](https://f-droid.org/wiki/page/eu.faircode.email/lastbuild))
|
|
|
|
Note that 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.
|
|
The GitHub release will automatically check for updates on GitHub.
|
|
You can turn this off in the advanced options.
|
|
|
|
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.
|
|
|
|
## Privacy
|
|
|
|
Please see [here](https://github.com/M66B/open-source-email/blob/master/PRIVACY.md#fairemail) for the privacy policy.
|
|
|
|
## Compatibility
|
|
|
|
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.
|
|
|
|
FairEmail will work properly on devices without any Google service installed.
|
|
|
|
See [here](https://github.com/M66B/open-source-email/blob/master/FAQ.md#known-problems) for known problems.
|
|
|
|
## Support / frequently asked questions
|
|
|
|
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.
|
|
|
|
## Contributing
|
|
|
|
*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*
|
|
|
|
* 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)
|
|
|
|
*Source code*
|
|
|
|
Building FairEmail from source code is straightforward with [Android Studio](http://developer.android.com/sdk/).
|
|
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/).
|
|
Please [contact me](https://contact.faircode.eu/?product=other) first to tell me what your plans are.
|
|
|
|
Please note that you agree to the license below by contributing, including the copyright.
|
|
|
|
## Attribution
|
|
|
|
FairEmail uses:
|
|
|
|
* [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).
|
|
* [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).
|
|
* [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).
|
|
* [dnsjava](http://www.xbill.org/dnsjava/). Copyright (c) 1998-2011, Brian Wellington. [BSD License](https://sourceforge.net/p/dnsjava/code/HEAD/tree/trunk/LICENSE).
|
|
* [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).
|
|
* [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).
|
|
* [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).
|
|
* [Mozilla ISPDB](https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration#ISPDB). *Free to use for any client.*
|
|
* [ShortcutBadger](https://github.com/leolin310148/ShortcutBadger). Copyright 2014 Leo Lin. [Apache license](https://github.com/leolin310148/ShortcutBadger/blob/master/LICENSE).
|
|
* [Bugsnag exception reporter for Android](https://github.com/bugsnag/bugsnag-android). Copyright (c) 2012 Bugsnag. [MIT License](https://github.com/bugsnag/bugsnag-android/blob/master/LICENSE.txt).
|
|
* [biweekly](https://github.com/mangstadt/biweekly). Copyright (c) 2013-2018, Michael Angstadt. [BSD 2-Clause](https://github.com/mangstadt/biweekly/blob/master/LICENSE).
|
|
* [PhotoView](https://github.com/chrisbanes/PhotoView). Copyright 2018 Chris Banes. [Apache License](https://github.com/chrisbanes/PhotoView/blob/master/LICENSE).
|
|
|
|
Error reporting is sponsored by:
|
|
|
|
|
|
|
|
[Bugsnag](https://www.bugsnag.com/) monitors application stability
|
|
and is used to [help improve FairEmail](https://github.com/M66B/open-source-email/blob/master/FAQ.md#user-content-faq104).
|
|
|
|
## License
|
|
|
|
[GNU General Public License version 3](https://www.gnu.org/licenses/gpl.txt)
|
|
|
|
Copyright © 2018-2019 Marcel Bokhorst. All rights reserved
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with FairEmail. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
|