Browse Source

update docs references

main
Distopico 6 years ago
parent
commit
401baf3d85
7 changed files with 35 additions and 32 deletions
  1. +2
    -2
      ISSUE_TEMPLATE.md
  2. +2
    -2
      PULL_REQUEST_TEMPLATE.md
  3. +2
    -1
      README.md
  4. +1
    -1
      app/src/main/java/org/dystopia/email/ActivityView.java
  5. +1
    -1
      app/src/main/java/org/dystopia/email/FragmentSetup.java
  6. +23
    -23
      docs/FAQ.md
  7. +4
    -2
      docs/SETUP.md

+ 2
- 2
ISSUE_TEMPLATE.md View File

@ -1,12 +1,12 @@
# Feature request # Feature request
* Did you check if there wasn't a similar feature request or open a PR with similar feature? * 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)?
* Did you read [this FAQ](https://framagit.org/dystopia-project/simple-email/blob/8f7296ddc2275471d4190df1dd55dee4025a5114/docs/FAQ.md#FAQ15)?
# Bug report # Bug report
* Did you check if there wasn't a similar bug report or PR open to fix similar bug? * 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?
* Are you using the [latest version](https://framagit.org/dystopia-project/simple-email/tags) of the app?
## Expected behavior ## Expected behavior


+ 2
- 2
PULL_REQUEST_TEMPLATE.md View File

@ -1,4 +1,4 @@
# Important # Important
* 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)?
* Did you read the [contributing section](https://framagit.org/dystopia-project/simple-email/blob/master/CONTRIBUTING.md)?
* Do you agree to [the license and the copyright](https://framagit.org/dystopia-project/simple-email/tree/master#license)?

+ 2
- 1
README.md View File

@ -78,7 +78,7 @@ because of a [bug in Android](https://issuetracker.google.com/issues/63377371).
## Frequently asked questions ## Frequently asked questions
See [here](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md) for a list of often asked questions.
See [here][faqs] for a list of often asked questions.
## Support ## Support
@ -122,3 +122,4 @@ SimpleEmail uses:
[free-software]: https://www.gnu.org/philosophy/free-sw.html [free-software]: https://www.gnu.org/philosophy/free-sw.html
[issue]: https://framagit.org/dystopia-project/simple-email/issues [issue]: https://framagit.org/dystopia-project/simple-email/issues
[pull-requests]: https://framagit.org/dystopia-project/simple-email/merge_requests [pull-requests]: https://framagit.org/dystopia-project/simple-email/merge_requests
[faqs]: https://framagit.org/dystopia-project/simple-email/blob/master/docs/FAQ.md

+ 1
- 1
app/src/main/java/org/dystopia/email/ActivityView.java View File

@ -619,7 +619,7 @@ public class ActivityView extends ActivityBase implements FragmentManager.OnBack
private Intent getIntentFAQ() { private Intent getIntentFAQ() {
Intent intent = new Intent(Intent.ACTION_VIEW); Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(Uri.parse("https://framagit.org/dystopia-project/simple-email/blob/a1c207ed9c3a15dacdf179717a0874bdf5d60ba5/FAQ.md"));
intent.setData(Uri.parse("https://framagit.org/dystopia-project/simple-email/blob/8f7296ddc2275471d4190df1dd55dee4025a5114/docs/FAQ.md"));
return intent; return intent;
} }


+ 1
- 1
app/src/main/java/org/dystopia/email/FragmentSetup.java View File

@ -477,7 +477,7 @@ public class FragmentSetup extends FragmentEx {
private Intent getIntentHelp() { private Intent getIntentHelp() {
Intent intent = new Intent(Intent.ACTION_VIEW); Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(Uri.parse("https://framagit.org/dystopia-project/simple-email/blob/a1c207ed9c3a15dacdf179717a0874bdf5d60ba5/SETUP.md"));
intent.setData(Uri.parse("https://framagit.org/dystopia-project/simple-email/blob/8f7296ddc2275471d4190df1dd55dee4025a5114/docs/SETUP.md"));
return intent; return intent;
} }


+ 23
- 23
docs/FAQ.md View File

@ -5,7 +5,7 @@ At the bottom you can find how to ask other questions, request features and repo
## Frequently Asked Questions ## Frequently Asked Questions
**Which permissions are needed and why?**
#### Which permissions are needed and why?
* have full network access (INTERNET): to send and receive email * have full network access (INTERNET): to send and receive email
* view network connections (ACCESS_NETWORK_STATE): to monitor internet connectivity changes * view network connections (ACCESS_NETWORK_STATE): to monitor internet connectivity changes
@ -15,7 +15,7 @@ At the bottom you can find how to ask other questions, request features and repo
* Optional: read your contacts (READ_CONTACTS): to autocomplete addresses and to show photos * Optional: read your contacts (READ_CONTACTS): to autocomplete addresses and to show photos
* Optional: find accounts on the device (GET_ACCOUNTS): to use [OAuth](https://en.wikipedia.org/wiki/OAuth) instead of passwords * Optional: find accounts on the device (GET_ACCOUNTS): to use [OAuth](https://en.wikipedia.org/wiki/OAuth) instead of passwords
**Why is there a permanent notification shown?**
#### Why is there a permanent notification shown?
A permanent status bar notification with the number of accounts being synchronized and the number of operations pending is shown A permanent status bar notification with the number of accounts being synchronized and the number of operations pending is shown
to prevent Android from killing the service that takes care of receiving and sending email. to prevent Android from killing the service that takes care of receiving and sending email.
@ -24,7 +24,7 @@ Most, if not all, other email apps don't show a notification with the "side effe
Background: this is because of the introduction of [doze mode](https://developer.android.com/training/monitoring-device-state/doze-standby) in Android 6 Marshmallow. Background: this is because of the introduction of [doze mode](https://developer.android.com/training/monitoring-device-state/doze-standby) in Android 6 Marshmallow.
**What are operations and why are they pending?**
#### What are operations and why are they pending?
The low priority status bar notification shows the number of pending operations, which can be: The low priority status bar notification shows the number of pending operations, which can be:
@ -41,11 +41,11 @@ The low priority status bar notification shows the number of pending operations,
Operations are processed only when there is a connection to the email server or when manually synchronizing. Operations are processed only when there is a connection to the email server or when manually synchronizing.
See also [this FAQ](#FAQ16). See also [this FAQ](#FAQ16).
**What is a valid security certificate?**
#### What is a valid security certificate?
Valid security certificates are officially signed (not self signed) and have matching a host name. Valid security certificates are officially signed (not self signed) and have matching a host name.
~~**What does 'no IDLE support' mean?**~~
~~What does 'no IDLE support' mean?~~
~~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.~~
@ -53,7 +53,7 @@ Valid security certificates are officially signed (not self signed) and have mat
~~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!~~
**How can I login to Gmail / G suite?**
#### How can I login to Gmail / G suite?
Preferably select Gmail as provider and select an account on your device. Preferably select Gmail as provider and select an account on your device.
@ -62,33 +62,33 @@ See here for instructions: [https://support.google.com/accounts/answer/185833](h
If this doesn't work, see here for more solutions: [https://support.google.com/mail/accounts/answer/78754](https://support.google.com/mail/accounts/answer/78754) If this doesn't work, see here for more solutions: [https://support.google.com/mail/accounts/answer/78754](https://support.google.com/mail/accounts/answer/78754)
**Why are messages in the outbox not moved to the sent folder?**
#### Why are messages in the outbox not moved to the sent folder?
Messages in the outbox are moved to the sent folder as soon as your provider adds the message to the sent folder. Messages in the outbox are moved to the sent folder as soon as your provider adds the message to the sent folder.
If this doesn't happen, your provider might not keep track of sent messages or you might be using an SMTP server not related to the provider. If this doesn't happen, your provider might not keep track of sent messages or you might be using an SMTP server not related to the provider.
In these cases you can enable the account option *Store sent messages* to let the app move messages from the outbox to the sent folder after sending. In these cases you can enable the account option *Store sent messages* to let the app move messages from the outbox to the sent folder after sending.
There is a menu to move sent messages to the sent folder after enabling this option. There is a menu to move sent messages to the sent folder after enabling this option.
**Can I use a Microsoft Exchange account?**
#### Can I use a Microsoft Exchange account?
You can use a Microsoft Exchange account if it is accessible via IMAP. You can use a Microsoft Exchange account if it is accessible via IMAP.
ActiveSync is not supported at this moment. ActiveSync is not supported at this moment.
See here for more information: [https://support.office.com/en-us/article/what-is-a-microsoft-exchange-account-47f000aa-c2bf-48ac-9bc2-83e5c6036793](https://support.office.com/en-us/article/what-is-a-microsoft-exchange-account-47f000aa-c2bf-48ac-9bc2-83e5c6036793) See here for more information: [https://support.office.com/en-us/article/what-is-a-microsoft-exchange-account-47f000aa-c2bf-48ac-9bc2-83e5c6036793](https://support.office.com/en-us/article/what-is-a-microsoft-exchange-account-47f000aa-c2bf-48ac-9bc2-83e5c6036793)
**What are identities?**
#### What are identities?
Identities represent email addresses you are sending *from*. Identities represent email addresses you are sending *from*.
Some providers allow you to have multiple email aliases. Some providers allow you to have multiple email aliases.
You can configure these by setting the email address field to the alias address and setting the user name field to your main email address. You can configure these by setting the email address field to the alias address and setting the user name field to your main email address.
**What does 'UIDPLUS not supported' mean?**
#### What does 'UIDPLUS not supported' mean?
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 SimpleEmail for this provider. So, unless your provider can enable this extension, you cannot use SimpleEmail for this provider.
~~**Why is STARTTLS for IMAP not supported?**~~
~~Why is STARTTLS for IMAP not supported?~~
~~STARTTLS starts with a not encrypted connection and is therefore not secure.~~ ~~STARTTLS starts with a not encrypted connection and is therefore not secure.~~
~~All well known IMAP servers support IMAP with a plain SSL connection, so there is no need to support STARTTLS for IMAP.~~ ~~All well known IMAP servers support IMAP with a plain SSL connection, so there is no need to support STARTTLS for IMAP.~~
@ -98,30 +98,30 @@ So, unless your provider can enable this extension, you cannot use SimpleEmail f
~~tl;dr; "*Additionally, even if you configure STARTTLS perfectly and use a valid certificate, there’s still no guarantee your communication will be encrypted.*"~~ ~~tl;dr; "*Additionally, even if you configure STARTTLS perfectly and use a valid certificate, there’s still no guarantee your communication will be encrypted.*"~~
**How does encryption/decryption work?**
#### How does encryption/decryption work?
First of all you need to install and configure [OpenKeychain](https://f-droid.org/en/packages/org.sufficientlysecure.keychain/). First of all you need to install and configure [OpenKeychain](https://f-droid.org/en/packages/org.sufficientlysecure.keychain/).
To encrypt a message before sending, just select the menu *Encrypt*. Similarly, to decrypt a received message, just select the menu *Decrypt*. To encrypt a message before sending, just select the menu *Encrypt*. Similarly, to decrypt a received message, just select the menu *Decrypt*.
**How does search on server work?**
#### How does search on server work?
You can start searching for messages on sender, recipient, subject or message text by using the magnify glass in the action bar of a folder (not in the unified inbox because it could be a collection of folders). You can start searching for messages on sender, recipient, subject or message text by using the magnify glass in the action bar of a folder (not in the unified inbox because it could be a collection of folders).
The server executes the search. Scrolling down will fetch more messages from the server. The server executes the search. Scrolling down will fetch more messages from the server.
Searching by the server might be case sensitive or case insensitive and might be on partial text or whole words, depending on the provider. Searching by the server might be case sensitive or case insensitive and might be on partial text or whole words, depending on the provider.
Search on server is a pro feature. Search on server is a pro feature.
**How can I setup Outlook with 2FA?**
#### How can I setup Outlook with 2FA?
To use Outlook with two factor authentication enabled, you need to create an app password. To use Outlook with two factor authentication enabled, you need to create an app password.
See [here](https://support.microsoft.com/en-us/help/12409/microsoft-account-app-passwords-two-step-verification) for the details. See [here](https://support.microsoft.com/en-us/help/12409/microsoft-account-app-passwords-two-step-verification) for the details.
**Can you add ... ?**
#### Can you add ... ?
* More themes/black theme: the goal is to keep the app as simple as possible, so no more themes will not be added. * More themes/black theme: the goal is to keep the app as simple as possible, so no more themes will not be added.
* Previewing message text in notification/widget: this is not always possible because the message text is initially not downloaded for larger messages. * Previewing message text in notification/widget: this is not always possible because the message text is initially not downloaded for larger messages.
* Executing filter rules: filter rules should be executed on the server because a battery powered device with possibly an unstable internet connection is not suitable for this. * Executing filter rules: filter rules should be executed on the server because a battery powered device with possibly an unstable internet connection is not suitable for this.
**Why are messages not being synchronized?**
#### Why are messages not being synchronized?
Possible causes of messages not being synchronized (sent or received) are: Possible causes of messages not being synchronized (sent or received) are:
@ -139,19 +139,19 @@ in particular of Huawei (see [here](https://www.forbes.com/sites/bensin/2016/07/
or Xiaomi (see [here](https://www.forbes.com/sites/bensin/2016/11/17/how-to-fix-push-notifications-on-xiaomis-miui-8-for-real/) for a fix) or Xiaomi (see [here](https://www.forbes.com/sites/bensin/2016/11/17/how-to-fix-push-notifications-on-xiaomis-miui-8-for-real/) for a fix)
stop apps and services too aggressively. stop apps and services too aggressively.
**Why does manual synchronize not work?**
#### Why does manual synchronize not work?
If the *Synchronize now* menu is dimmed, there is no connection to the account. 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.
**How do I enable the notification light?**
#### How do I enable the notification light?
Before Android 8 Oreo: there is an advanced option in the setup for this. Before Android 8 Oreo: there is an advanced option in the setup for this.
Android 8 Oreo and later: see [here](https://developer.android.com/training/notify-user/channels) about how to configure notification channels. Android 8 Oreo and later: see [here](https://developer.android.com/training/notify-user/channels) about how to configure notification channels.
**Why do I get 'Couldn't connect to host' ?**
#### Why do I get 'Couldn't connect to host' ?
The message *Couldn't connect to host ...* means that SimpleEmail 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.
@ -164,7 +164,7 @@ Possible causes are:
If you are using a VPN, the VPN provider might block the connection because it is too aggressively trying to prevent spam. If you are using a VPN, the VPN provider might block the connection because it is too aggressively trying to prevent spam.
**Why do I get 'Too many simultaneous connections' ?**
#### Why do I get 'Too many simultaneous connections' ?
The message *Too many simultaneous connections* is sent by the email server when there are too many connections to the same email account at the same time. The message *Too many simultaneous connections* is sent by the email server when there are too many connections to the same email account at the same time.
@ -174,13 +174,13 @@ Possible causes are:
* The same email client is connected multiple times to the same account * The same email client is connected multiple times to the same account
* The previous connection was terminated abruptly for example by losing internet connectivity * The previous connection was terminated abruptly for example by losing internet connectivity
**What is browse messages on the server?**
#### What is browse messages on the server?
Browse messages on the server will fetch messages from the email server in real time Browse messages on the server will fetch messages from the email server in real time
when you reach the end of the list of synchronized messages, even when the folder is set to not synchronize. when you reach the end of the list of synchronized messages, even when the folder is set to not synchronize.
You can disable this feature under *Setup* > *Advanced options* > *Browse messages on the server*. You can disable this feature under *Setup* > *Advanced options* > *Browse messages on the server*.
**Why can't I select an image, attachment or a file to export/import?**
#### Why can't I select an image, attachment or a file to export/import?
If a menu item to select a file is disabled (dimmed), 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),
@ -189,7 +189,7 @@ for example because your custom ROM does not include it or because it was remove
SimpleEmail 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.
**Can I help to translate SimpleEmail in my own language?**
#### Can I help to translate SimpleEmail in my own language?
Yes, you can translate the texts of SimpleEmail in your own language, please open a [pull requests][pull-requests] with the changes, Yes, you can translate the texts of SimpleEmail in your own language, please open a [pull requests][pull-requests] with the changes,
we are looking for web service to automated the process. we are looking for web service to automated the process.


+ 4
- 2
docs/SETUP.md View File

@ -32,7 +32,7 @@ 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://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md#FAQ9) about using aliases.
See [this FAQ](https://framagit.org/dystopia-project/simple-email/blob/8f7296ddc2275471d4190df1dd55dee4025a5114/docs/FAQ.md) about using aliases.
## Permissions ## Permissions
@ -47,4 +47,6 @@ Tap *Disable battery optimizations* and follow the instructions.
## Questions ## Questions
If you have a question or problem, please [see here](https://framagit.org/dystopia-project/simple-email/blob/master/FAQ.md).
If you have a question or problem, please [see here][faqs].
[faqs]: https://framagit.org/dystopia-project/simple-email/blob/8f7296ddc2275471d4190df1dd55dee4025a5114/docs/FAQ.md

Loading…
Cancel
Save