Fincer
/
simple-email
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
Browse Source

update template and docs

main
Distopico Vegan 6 years ago
parent
6291cbc43f
commit
a1c207ed9c
5 changed files with 33 additions and 56 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +8
    -37
      FAQ.md
  2. +6
    -10
      ISSUE_TEMPLATE.md
  3. +2
    -2
      PULL_REQUEST_TEMPLATE.md
  4. +10
    -0
      README.md
  5. +7
    -7
      SETUP.md

+ 8
- 37
FAQ.md View File

@ -1,4 +1,4 @@
# FairEmail
# SimpleEmail
If you have a question, please check the frequently asked questions below first. If you have a question, please check the frequently asked questions below first.
At the bottom you can find how to ask other questions, request features and report bugs. At the bottom you can find how to ask other questions, request features and report bugs.
@ -55,7 +55,7 @@ Valid security certificates are officially signed (not self signed) and have mat
~~Without [IMAP IDLE](https://en.wikipedia.org/wiki/IMAP_IDLE) emails need to be periodically fetched,~~ ~~Without [IMAP IDLE](https://en.wikipedia.org/wiki/IMAP_IDLE) emails need to be periodically fetched,~~
~~which is a waste of battery power and internet bandwidth and will delay notification of new emails.~~ ~~which is a waste of battery power and internet bandwidth and will delay notification of new emails.~~
~~Since the goal of FairEmail is to offer safe and fast email, providers without IMAP IDLE are not supported.~~
~~Since the goal of SimpleEmail is to offer safe and fast email, providers without IMAP IDLE are not supported.~~
~~You should consider this a problem of the provider, not of the app.~~ ~~You should consider this a problem of the provider, not of the app.~~
~~Almost all email providers offer IMAP IDLE, with as notable exception Yahoo!~~ ~~Almost all email providers offer IMAP IDLE, with as notable exception Yahoo!~~
@ -97,7 +97,7 @@ You can configure these by setting the email address field to the alias address
The error message *UIDPLUS not supported* means that your email provider does not provide the IMAP [UIDPLUS extension](https://tools.ietf.org/html/rfc4315). The error message *UIDPLUS not supported* means that your email provider does not provide the IMAP [UIDPLUS extension](https://tools.ietf.org/html/rfc4315).
This IMAP extension is required to implement two way synchronization, which is not an optional feature. This IMAP extension is required to implement two way synchronization, which is not an optional feature.
So, unless your provider can enable this extension, you cannot use FairEmail for this provider.
So, unless your provider can enable this extension, you cannot use SimpleEmail for this provider.
<a name="FAQ11"></a> <a name="FAQ11"></a>
~~**(11) Why is STARTTLS for IMAP not supported?**~~ ~~**(11) Why is STARTTLS for IMAP not supported?**~~
@ -163,34 +163,6 @@ If the *Synchronize now* menu is dimmed, there is no connection to the account.
See the previous question for more information. See the previous question for more information.
<a name="FAQ19"></a>
**(19) Why are the pro features so expensive?**
The right question is "*why are there so many taxes and fees?*":
* VAT: 25% (depending on your country)
* Google fee: 30%
* Income tax: 50%
So, what is left for the developer is just a fraction of what you pay.
Note that only some convenience and advanced features need to be purchased, which means that FairEmail is basically free to use.
Also note that most free apps will appear not to be sustainable in the end, whereas FairEmail is properly maintained and supported,
and that free apps may have a catch, like sending privacy sensitive information to the internet.
<a name="FAQ20"></a>
**(20) Can I get a refund?**
If a purchased pro feature doesn't work as intended
and this isn't caused by a problem in the free features
and I cannot fix the problem in a timely manner, you can get a refund.
In all other cases there is no refund possible.
In no circumstances there is a refund possible for any problem related to the free features,
since there wasn't paid anything for them and because they can be evaluated without any limitation.
I take my responsibility as seller to deliver what has been promised
and I expect that you take responsibility for informing yourself of what you are buying.
<a name="FAQ21"></a> <a name="FAQ21"></a>
**(21) How do I enable the notification light?** **(21) How do I enable the notification light?**
@ -201,7 +173,7 @@ Android 8 Oreo and later: see [here](https://developer.android.com/training/noti
<a name="FAQ22"></a> <a name="FAQ22"></a>
**(22) Why do I get 'Couldn't connect to host' ?** **(22) Why do I get 'Couldn't connect to host' ?**
The message *Couldn't connect to host ...* means that FairEmail was not able to connect to the email server.
The message *Couldn't connect to host ...* means that SimpleEmail was not able to connect to the email server.
Possible causes are: Possible causes are:
@ -237,16 +209,15 @@ If a menu item to select a file is disabled (dimmed),
likely the [storage access framework](https://developer.android.com/guide/topics/providers/document-provider), likely the [storage access framework](https://developer.android.com/guide/topics/providers/document-provider),
a standard Android component, is not present, a standard Android component, is not present,
for example because your custom ROM does not include it or because it was removed. for example because your custom ROM does not include it or because it was removed.
FairEmail does not request storage permissions, so this framework is required to select files and folders.
SimpleEmail does not request storage permissions, so this framework is required to select files and folders.
No app, except maybe file managers, targetting Android 4.4 KitKat or later should ask for storage permissions because it would allow access to *all* files. No app, except maybe file managers, targetting Android 4.4 KitKat or later should ask for storage permissions because it would allow access to *all* files.
<a name="FAQ26"></a> <a name="FAQ26"></a>
**(26) Can I help to translate FairEmail in my own language?**
**(26) Can I help to translate SimpleEmail in my own language?**
Yes, you can translate the texts of FairEmail in your own language [here](https://crowdin.com/project/open-source-email).
Yes, you can translate the texts of SimpleEmail in your own language [here](https://crowdin.com/project/open-source-email).
Registration is free. Registration is free.
<br> <br>
If you have another question, want to request a feature or report a bug, you can use [this forum](https://forum.xda-developers.com/android/apps-games/source-email-t3824168).
Registration is free.
If you have another question, want to request a feature or report a bug, you can send a [email](distopico@riseup.net) or open PR.

+ 6
- 10
ISSUE_TEMPLATE.md View File

@ -1,16 +1,12 @@
# Question
* For questions, please use [this forum](https://forum.xda-developers.com/android/apps-games/source-email-t3824168).
# Feature request # Feature request
* Did you check if there wasn't a similar feature request?
* Did you read [this FAQ](https://github.com/M66B/open-source-email/blob/master/FAQ.md#FAQ15)?
* Did you check if there wasn't a similar feature request or open a PR with similar feature?
* Did you read [this FAQ](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md#FAQ15)?
# Bug report # Bug report
* Did you check if there wasn't a similar bug report?
* Are you using the [latest version](https://github.com/M66B/open-source-email/releases) of the app?
* Did you check if there wasn't a similar bug report or PR open to fix similar bug?
* Are you using the [latest version](https://framagit.org/dystopia-project/simple-email/releases) of the app?
## Expected behavior ## Expected behavior
@ -21,8 +17,8 @@
## Steps to reproduce the problem ## Steps to reproduce the problem
1. 1.
1.
1.
2.
3.
## Version ## Version


+ 2
- 2
PULL_REQUEST_TEMPLATE.md View File

@ -1,4 +1,4 @@
# Important # Important
* Did you read the [contributing section](https://github.com/M66B/open-source-email#contributing)?
* Do you agree to [the license and the copyright](https://github.com/M66B/open-source-email#license)?
* Did you read the [contributing section](https://framagit.org/dystopia-project/simple-email#contributing)?
* Do you agree to [the license and the copyright](https://framagit.org/dystopia-project/simple-email#license)?

+ 10
- 0
README.md View File

@ -84,6 +84,16 @@ SimpleEmail requires at least Android 6 Marshmallow.
SimpleEmail might occasionally crash on Motorola/Lenovo devices with Android 7 Nougat or earlier SimpleEmail might occasionally crash on Motorola/Lenovo devices with Android 7 Nougat or earlier
because of a [bug in Android](https://issuetracker.google.com/issues/63377371). because of a [bug in Android](https://issuetracker.google.com/issues/63377371).
## Frequently asked questions
See [here](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md) for a list of often asked questions.
## Support
* For support on SimpleEmail, please open a [issue](https://framagit.org/dystopia-project/simple-email/issues)
For support on authorizing accounts you should contact your provider.
## Contributing ## Contributing
*Documentation* *Documentation*


+ 7
- 7
SETUP.md View File

@ -1,6 +1,6 @@
# Setup help # Setup help
Setting up FairEmail is fairly simple.
Setting up SimpleEmail is fairly simple.
You'll need to add at least one account to receive email and at least one identity if you want to send email. You'll need to add at least one account to receive email and at least one identity if you want to send email.
## Requirements ## Requirements
@ -18,12 +18,12 @@ For security reasons, your account need to have a non empty password set.
To add an account, tap on *Manage accounts* and tap on the orange *add* button at the bottom. To add an account, tap on *Manage accounts* and tap on the orange *add* button at the bottom.
Select a provider from the list, enter the username, which is mostly your email address and enter your password. Select a provider from the list, enter the username, which is mostly your email address and enter your password.
If you use Gmail, tap *Select account* to fill in the username and password. If you use Gmail, tap *Select account* to fill in the username and password.
Tap *Check* to let FairEmail connect to the email server and fetch a list of system folders.
Tap *Check* to let SimpleEmail connect to the email server and fetch a list of system folders.
After reviewing the system folder selection you can add the account by tapping *Save*. After reviewing the system folder selection you can add the account by tapping *Save*.
If your provider is not in the list of providers, select *Custom*. If your provider is not in the list of providers, select *Custom*.
Enter the domain name, for example *gmail.com* and tap *Get settings*. Enter the domain name, for example *gmail.com* and tap *Get settings*.
If your provider supports [auto-discovery](https://tools.ietf.org/html/rfc6186), FairEmail will fill in the host name and port number,
If your provider supports [auto-discovery](https://tools.ietf.org/html/rfc6186), SimpleEmail will fill in the host name and port number,
else check the setup instructions of your provider for the right IMAP host name and port number. else check the setup instructions of your provider for the right IMAP host name and port number.
## Identity ## Identity
@ -32,19 +32,19 @@ Similarly, to add an identity, tap on *Manage identity* and tap on the orange *a
Enter the name you want to appear in de from address of the emails you send and select a linked account. Enter the name you want to appear in de from address of the emails you send and select a linked account.
Tap *Save* to add the identity. Tap *Save* to add the identity.
See [this FAQ](https://github.com/M66B/open-source-email/blob/master/FAQ.md#FAQ9) about using aliases.
See [this FAQ](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md#FAQ9) about using aliases.
## Permissions ## Permissions
If you want to lookup email addresses, have contact photos shown, etc, you'll need to grant read contacts permission to FairEmail.
If you want to lookup email addresses, have contact photos shown, etc, you'll need to grant read contacts permission to SimpleEmail.
Just tap *Grant permissions* and select *Allow*. Just tap *Grant permissions* and select *Allow*.
## Battery optimizations ## Battery optimizations
On recent Android versions, Android will put apps to sleep when the screen is off for some time to reduce battery usage. On recent Android versions, Android will put apps to sleep when the screen is off for some time to reduce battery usage.
If you want to receive new emails without delays, you should disable battery optimizations for FairEmail.
If you want to receive new emails without delays, you should disable battery optimizations for SimpleEmail.
Tap *Disable battery optimizations* and follow the instructions. Tap *Disable battery optimizations* and follow the instructions.
## Questions ## Questions
If you have a question or problem, please [see here](https://github.com/M66B/open-source-email/blob/master/FAQ.md).
If you have a question or problem, please [see here](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md).

Write Preview
Loading…
Cancel
Save