Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

139 lines
5.4 KiB

6 years ago
6 years ago
6 years ago
  1. # FairEmail
  2. *Open source, privacy friendly email app*
  3. This email app might be for you if your current email app:
  4. * takes long to receive or show messages
  5. * can manage only one email address
  6. * cannot show conversations
  7. * cannot work offline
  8. * looks outdated
  9. * is not maintained
  10. * stores your email on their servers
  11. * is closed source, potentially violating your privacy
  12. This app is minimalistic by design, so you can concentrate on reading and writing messages.
  13. This app starts a foreground service with a low priority status bar notification to make sure you'll never miss new email.
  14. ## Features
  15. * 100 % open source
  16. * Multiple accounts (inboxes)
  17. * Multiple identities (outboxes)
  18. * Unified inbox
  19. * Message threading
  20. * Distraction free writing
  21. * Two way synchronization
  22. * Offline storage and operations
  23. * Battery friendly
  24. * Low data usage
  25. * Folder management
  26. * Material design
  27. ## Pro features
  28. * Signatures
  29. * Dark theme
  30. * Account colors
  31. * Standard replies
  32. * Sort on time, unread or starred
  33. * Search on server
  34. * Preview sender/subject in new messages status bar notification
  35. * Export settings
  36. ## Simple
  37. * Easy navigation
  38. * No unnecessary settings
  39. * No bells and whistles
  40. ## Secure
  41. * Allow encrypted connections only
  42. * Accept valid security certificates only
  43. * Authentication required
  44. * Safe message view (styling, scripting and unsafe HTML removed)
  45. * No special permissions required
  46. * No advertisements
  47. * No analytics and no tracking
  48. ## Efficient
  49. * [IMAP IDLE](https://en.wikipedia.org/wiki/IMAP_IDLE) (push messages) supported
  50. * Built with latest development tools and libraries
  51. * Android 6 Marshmallow or later required
  52. ## Downloads
  53. * [GitHub](https://github.com/M66B/open-source-email/releases)
  54. * [Play store](https://play.google.com/apps/testing/eu.faircode.email)
  55. ## Compatibility
  56. FairEmail requires at least Android 6 Marshmallow.
  57. FairEmail might occasionally crash on Motorola/Lenovo devices with Android 7 Nougat or earlier
  58. because of a [bug in Android](https://issuetracker.google.com/issues/63377371).
  59. ## Frequently asked questions
  60. See [here](https://github.com/M66B/open-source-email/blob/master/FAQ.md) for a list of often asked questions.
  61. ## Support
  62. * For support on FairEmail, please go [here](https://forum.xda-developers.com/android/apps-games/source-email-t3824168)
  63. ## Contributing
  64. *Documentation*
  65. Contributions to this document and the frequently asked questions
  66. are preferred in the form of [pull requests](https://help.github.com/articles/creating-a-pull-request/).
  67. *Translations*
  68. * You can translate the in-app texts of FairEmail [here](https://crowdin.com/project/open-source-email)
  69. * If your language is not listed, please send a message through [this contact form](https://contact.faircode.eu/)
  70. *Source code*
  71. Building FairEmail from source code is straightforward with [Android Studio](http://developer.android.com/sdk/).
  72. It is expected that you can solve build problems yourself, so there is no support on building.
  73. Source code contributions are preferred in the form of [pull requests](https://help.github.com/articles/creating-a-pull-request/).
  74. Please [contact me](https://contact.faircode.eu/) first to tell me what your plans are.
  75. Please note that you agree to the license below by contributing, including the copyright.
  76. ## Attribution
  77. FairEmail uses:
  78. * [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).
  79. * [jsoup](https://jsoup.org/). Copyright © 2009 - 2017 Jonathan Hedley. [MIT license](https://jsoup.org/license).
  80. * [JCharset](http://www.freeutils.net/source/jcharset/). Copyright © 2005-2015 Amichai Rothman. [GNU General Public License](http://www.freeutils.net/source/jcharset/#license)
  81. * [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).
  82. * [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).
  83. * [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).
  84. * [dnsjava](http://www.xbill.org/dnsjava/). Copyright (c) 1998-2011, Brian Wellington. [BSD License](https://sourceforge.net/p/dnsjava/code/HEAD/tree/trunk/LICENSE).
  85. ## License
  86. [GNU General Public License version 3](https://www.gnu.org/licenses/gpl.txt)
  87. Copyright (c) 2018 Marcel Bokhorst. All rights reserved
  88. FairEmail is free software: you can redistribute it and/or modify
  89. it under the terms of the GNU General Public License as published by
  90. the Free Software Foundation, either version 3 of the License, or
  91. (at your option) any later version.
  92. FairEmail is distributed in the hope that it will be useful,
  93. but WITHOUT ANY WARRANTY; without even the implied warranty of
  94. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  95. GNU General Public License for more details.
  96. You should have received a copy of the GNU General Public License
  97. along with FairEmail. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).