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.

138 lines
5.4 KiB

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