FairEmail/README.md

150 lines
5.9 KiB
Markdown
Raw Normal View History

2018-09-17 07:09:35 +00:00
# FairEmail
2018-08-02 13:33:06 +00:00
2018-08-23 14:04:50 +00:00
*Open source, privacy friendly email app*
2018-08-02 13:33:06 +00:00
This email app might be for you if your current email app:
2018-08-04 09:47:23 +00:00
* takes long to receive or show messages
2018-09-14 12:12:19 +00:00
* can manage only one email address
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-09-17 07:09:35 +00:00
## Features
2018-08-02 13:33:06 +00:00
* 100 % open source
* Multiple accounts (inboxes)
* Multiple identities (outboxes)
* Unified inbox
2018-10-22 13:14:46 +00:00
* Conversation view
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
2018-09-17 07:09:35 +00:00
* Folder management
2018-08-02 13:33:06 +00:00
* Material design
2018-09-17 07:09:35 +00:00
## Pro features
2018-08-26 07:26:56 +00:00
2018-09-07 08:44:48 +00:00
* Signatures
2018-09-16 06:27:31 +00:00
* Dark theme
2018-09-12 19:19:42 +00:00
* Account colors
2018-10-24 10:13:41 +00:00
* Multiple select
2018-09-04 19:00:58 +00:00
* Standard replies
2018-09-13 10:29:07 +00:00
* Sort on time, unread or starred
2018-09-21 12:14:19 +00:00
* Search on server
2018-09-07 08:44:48 +00:00
* Preview sender/subject in new messages status bar notification
2018-10-29 09:20:59 +00:00
* Encryption/decryption
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
* Easy navigation
2018-09-14 12:12:19 +00:00
* No unnecessary settings
2018-08-02 13:33:06 +00:00
* No bells and whistles
2018-09-17 07:09:35 +00:00
## Secure
2018-08-02 13:33:06 +00:00
* Allow encrypted connections only
* Accept valid security certificates only
2018-09-03 09:42:59 +00:00
* Authentication required
2018-09-14 12:12:19 +00:00
* Safe message view (styling, scripting and unsafe HTML removed)
2018-08-02 13:33:06 +00:00
* No special permissions required
* No advertisements
* No analytics and no tracking
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
* Android 6 Marshmallow or later required
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:
* 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
2018-10-10 09:23:24 +00:00
## Compatibility
FairEmail requires at least Android 6 Marshmallow.
2018-10-17 15:37:44 +00:00
FairEmail might occasionally crash on Motorola/Lenovo devices with Android 7 Nougat or earlier
2018-10-10 09:23:24 +00:00
because of a [bug in Android](https://issuetracker.google.com/issues/63377371).
2018-09-17 07:09:35 +00:00
## Frequently asked questions
2018-08-02 13:33:06 +00:00
2018-08-02 13:57:16 +00:00
See [here](https://github.com/M66B/open-source-email/blob/master/FAQ.md) for a list of often asked questions.
2018-08-02 13:33:06 +00:00
2018-09-17 07:09:35 +00:00
## Support
2018-08-02 13:33:06 +00:00
2018-08-14 05:53:24 +00:00
* For support on FairEmail, please go [here](https://forum.xda-developers.com/android/apps-games/source-email-t3824168)
2018-08-02 13:33:06 +00:00
2018-10-30 17:31:55 +00:00
For support on authorizing accounts you should contact your provider.
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-08-14 05:53:24 +00:00
* You can translate the in-app texts of FairEmail [here](https://crowdin.com/project/open-source-email)
2018-08-02 13:33:06 +00:00
* If your language is not listed, please send a message through [this contact form](https://contact.faircode.eu/)
*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/).
Please [contact me](https://contact.faircode.eu/) first to tell me what your plans are.
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
* [JavaMail](https://javaee.github.io/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).
* [JCharset](http://www.freeutils.net/source/jcharset/). Copyright © 2005-2015 Amichai Rothman. [GNU General Public License](http://www.freeutils.net/source/jcharset/#license)
2018-08-02 13:33:06 +00:00
* [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-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)
Copyright (c) 2018 Marcel Bokhorst. All rights reserved
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/).