Added attribution

This commit is contained in:
M66B 2022-07-03 11:33:55 +02:00
parent d739b19f95
commit 91c42a97ab
4 changed files with 41 additions and 15 deletions

View File

@ -1,16 +1,17 @@
# First Configuration
# First configuration
**NOTE:** If you have any troubles, check [this extensive FAQ](https://github.com/M66B/FairEmail/blob/master/FAQ.md).
You may also ask in [this XDA Forum thread](https://forum.xda-developers.com/t/app-5-0-fairemail-fully-featured-open-source-privacy-oriented-email-app.3824168/)
or via [this contact form](https://contact.faircode.eu/?product=fairemailsupport). Bad reviews won't help you or the developer, so try asking in person first.
## 1. Accepting the license agreement
When you start the app for the first time, you need to accept the license agreement.
![license agreement](images/firstconf-00_license.png)
## 2. Starting the wizard
FairEmail has a setup wizard integrated. It will lead you through the process. Choose the wizard for easy configuration.
FairEmail has a setup wizard integrated. It will lead you through the process. Choose the wizard for easy configuration.
If your email provider is not listed, or if you want to authenticate using a password, choose "Other provider".
**NOTE:** OAuth only works for the Play Store and GitHub version. Third party builds (e.g. on F-Droid) do not support OAuth.
@ -19,8 +20,8 @@ If your email provider is not listed, or if you want to authenticate using a pas
![wizard options](images/firstconf-01_wizard-00.png)
## 3. Fill in credentials
Fill in your screen name, your email address and your password. FairEmail will fetch the server settings automatically for most email providers.
If you want to check the password for typos, you can enable showing the entered password by clicking on the eye icon.
After you have entered everything, press the "check" button.
@ -29,14 +30,13 @@ After you have entered everything, press the "check" button.
![wizard "other provider"](images/firstconf-02_wizard-01.png)
## 4. Setting up default folders
FairEmail will try to recognize the default folders for the inbox, sent messages, spam messages, drafts and archived messages.
Accept with "OK" if the settings look fine. Otherwise, you may also edit the settings.
![default folders dialog](images/firstconf-03_wizard-02.png)
## 5. Disable battery optimization
Below the wizard, there are two more options numbered:
@ -56,8 +56,8 @@ That's it, your app is set up to work.
![inbox image](images/firstconf-04_inbox-00.png)
## Optional settings
FairEmail will already work with the configuration above. However, you may want to change some minor things.
As FairEmail comes with a lot of options, you can very likely adjust the app and its behavior the way you personally would like it.
However, all of those options are optional. The app works stable with the default options without requiring any adjustment by you.
@ -67,6 +67,7 @@ The most common three settings you might want to set on the first run are mentio
Apart from that, there's also [this separate manual describing various settings / options](settings-overview.md) in FairEmail.
### 1. Disable the permanent notification
The permanent notification is a necessary foreground service as many phones kill the app once there is nothing in the foreground anymore.
However, it is designed in a way that it has no toll on your battery. If the permanent notification banner annoys you, you can just turn the notification off.
To do so, press and hold on the notification and then click on the settings icon (gear symbol).
@ -75,6 +76,7 @@ Now disable the slider for the "Monitor".
![foreground services notification](images/firstconf_watchdog.png)
### 2. Changing start screen
By default you will see a unified inbox on your start screen, which will summarize the inboxes of all your mail accounts in FairEmail.
If you prefer to have a classic account view on start, maybe because you manage a greater number of email accounts with FairEmail,
you can do this as follows:
@ -86,6 +88,7 @@ you can do this as follows:
5. Use the back key to get back to the start screen
### 3. Changing the theme
You can slightly change the way the app looks. To this end, FairEmail comes with multiple pre-installed themes.
You can switch themes like this:
@ -97,3 +100,6 @@ You can switch themes like this:
**NOTE:** Dynamic themes are not possible in Android.
See [FAQ #164 Can you add customizable themes?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq164) for further details.
Thanks @[mkasimd](https://github.com/mkasimd/) for contributing this documentation.

View File

@ -1,4 +1,4 @@
# Manual Configuration
# Manual configuration
**NOTE:** If you have any troubles, check [this extensive FAQ](https://github.com/M66B/FairEmail/blob/master/FAQ.md).
You may also ask in [this XDA Forum thread](https://forum.xda-developers.com/t/app-5-0-fairemail-fully-featured-open-source-privacy-oriented-email-app.3824168/)
@ -7,11 +7,13 @@ or via [this contact form](https://contact.faircode.eu/?product=fairemailsupport
**NOTE:** In most cases, an automatic configuration via the wizard described in the [first configuration guide](first-config.md) should work right away. If you are using a custom domain & server and the wizard doesn't work as expected, you can enable automatic configuration by implementing [RFC 6186](https://datatracker.ietf.org/doc/html/rfc6186) within the DNS and / or [Thunderbird:Autoconfiguration](https://wiki.mozilla.org/Thunderbird:Autoconfiguration). An independent guide for both methods can be found in [Auto Discover | LD Documentation](https://doc.ld-online.net/e-mail/auto-discover).
## Accounts & identities
**Accounts** are basically your IMAP and POP3 accounts for reading mails. FairEmail uses your account to fetch _incoming_ mails.
**Identities** are SMTP accounts for sending mails. FairEmail will use the identity to send _outgoing_ mails.
## Adding a new email account
**NOTE:** This step requires working internet connection.
Adding a new email account (account + identity) is pretty straightforward. Just follow these steps:
@ -32,3 +34,5 @@ Here are some screenshots to help you visualize these steps:
![Manual setup and account options](images/manualconf-01.png)
![Adding new IMAP / POP3 account](images/manualconf-02.png)
![Saving account](images/manualconf-03.png)
Thanks @[mkasimd](https://github.com/mkasimd/) for contributing this documentation.

View File

@ -1,4 +1,4 @@
# FairEmail Manuals
# FairEmail manuals
The following manuals describe how to configure FairEmail as well as how to modify the settings on your own requirements.
FairEmail offers many options you can always explore yourself within the app or in the FAQ article.
@ -10,6 +10,8 @@ or via [this contact form](https://contact.faircode.eu/?product=fairemailsupport
## Index
* [First Configuration](first-config.md) - A manual how to set up FairEmail to just work
* [Settings Overview](settings-overview.md) - A manual describing where and how to find some settings & options
* [Manual Configuration](manual-config.md) - A manual describing how to manually add your accounts (without the wizard)
* [First configuration](first-config.md) - A manual how to set up FairEmail to just work
* [Settings overview](settings-overview.md) - A manual describing where and how to find some settings & options
* [Manual configuration](manual-config.md) - A manual describing how to manually add your accounts (without the wizard)
Thanks @[mkasimd](https://github.com/mkasimd/) for contributing this documentation.

View File

@ -1,4 +1,5 @@
# Settings Overview
# Settings overview
In this manual, some settings and options in FairEmail will be described without going into the details.
Be reminded that all settings here are optional. FairEmail works without any modifications.
You can simply add an account and already start reading and writing your emails.
@ -10,6 +11,7 @@ or via [this contact form](https://contact.faircode.eu/?product=fairemailsupport
**NOTE:** A tutorial on the first configuration of the app and on how to add an account can be found in the [first configuration manual](first-config.md)
## Opening the settings
To open the settings, tap the three dashes in the top left corner (hamburger menu) and select "Settings" with the gear icon.
That's it, you're already within the settings.
@ -40,16 +42,19 @@ You will now find multiple categories:
10. [Enable error reporting](#10-enable-error-reporting)
## 1. Adding a new account
If you want to add a new account, use the wizard in the Main screen. Follow [this first configuration guide](first-config.md).
You can also [add an account manually](/manual-config.md). That requires you to enter everything manually, so it's not recommended.
## 2. Receiving messages in the daytime only
You might want to not receive any messages at late hours. It is very easy and straightforward to tell FairEmail to synchronize only during specified days and hours.
You can also exclude some accounts from this scheduling such that they are always synchronized regardless of the day and time.
More information on scheduling can be found in [FAQ #78 How do I use schedules?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq78).
### 2.1 Set synchronization day & time
Follow the following steps:
1. Go to the "Receive" settings
@ -57,6 +62,7 @@ Follow the following steps:
3. Set the days and time-frame messages should be synchronized
### 2.2 Exclude an account from the schedule
You might want to exclude one specific account from the schedule and always receive messages regardless of the day and time.
If so, follow these steps:
@ -69,6 +75,7 @@ If so, follow these steps:
## 3. Enable checking for spam
FairEmail can perform various checks on incoming mails. This can be enabled in the "Receive" settings within the "Checks" options.
1. Go to the "Receive" settings
@ -78,9 +85,8 @@ FairEmail can perform various checks on incoming mails. This can be enabled in t
**NOTE**: The status of the performed checks can be indicated through an icon for each message.
To enable this, open the "Display" settings enable showing warnings and the status indicator under "Advanced".
## 4. Edit your email signature
The email signature is the text that is always added below the messages you send. The signatures can vary for each identity you send emails from.
To add or edit your signature, do as follows:
@ -91,6 +97,7 @@ To add or edit your signature, do as follows:
5. Enter or edit your signature and save it
## 5. Limit mobile data usage
You can set up whether to use metered connections such as mobile data and how much kilobytes of data to use per message.
You can also disable downloading messages when roaming.
@ -103,6 +110,7 @@ Go to the "Connection" settings and you will find the following "General" option
More information can be found in [FAQ #105 How does the roam-like-at-home option work?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq105).
## 6. Changing the theme
You can slightly change the way the app looks. To this end, FairEmail comes with multiple pre-installed themes.
You can switch themes like this:
@ -116,6 +124,7 @@ You can switch themes like this:
See [FAQ #164 Can you add customizable themes?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq164) for further details.
## 7. Changing start screen
By default you will see a unified inbox on your start screen, which will summarize the inboxes of all your mail accounts in FairEmail.
If you prefer to have a classic account view on start, maybe because you manage a greater number of email accounts with FairEmail,
you can do this as follows:
@ -127,6 +136,7 @@ you can do this as follows:
5. Use the back key to get back to the start screen
## 8. Show an avatar for each sender
There are multiple ways to show an avatar for each sender. You can enable multiple at once.
1. Go to the "Display" settings
@ -137,6 +147,7 @@ There are multiple ways to show an avatar for each sender. You can enable multip
Gravatars and Libravatar might not be available in the PlayStore version as Google falsely flags the app to be a spyware otherwise. Also see [this XDA thread](https://forum.xda-developers.com/t/app-5-0-fairemail-fully-featured-open-source-privacy-oriented-email-app.3824168/page-1125#post-87018167) on the matter.
## 9. Enable biometric authentication
You might want to protect your app via a PIN or a fingerprint to ensure no unauthorized person gains access to your messages.
To do so, follow these steps:
@ -147,6 +158,7 @@ To do so, follow these steps:
More information can be found in [FAQ #113 How does biometric authentication work?](https://github.com/M66B/FairEmail/blob/master/docs/FAQ-en-rGB.md#user-content-faq113).
## 10. Enable error reporting
Error reporting is disabled by default. However, enabling this helps the developer finding any bugs and improving the app.
If you want to enable error reporting, do as follows:
@ -154,3 +166,5 @@ If you want to enable error reporting, do as follows:
2. Enable the option "Send error reports"
More information can be found in [FAQ #104 What do I need to know about error reporting?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq104).
Thanks @[mkasimd](https://github.com/mkasimd/) for contributing this documentation.