Added the tutorials again after rebasing

apparently, the dev branch isn't really where development should be sent to, so rebased to master to ensure PR without conflicts.
pull/208/head
M. Kasim 3 years ago
parent 31c6dd2692
commit d1ccee6baf

@ -0,0 +1,97 @@
# 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 email to [marcel@faircode.eu](mailto:marcel@faircode.eu). 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, that 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.
**NOTE:** Google OAuth only works for Google accounts added on your Android device. Also see [FAQ #111 Is OAuth supported?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq111)
![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.
**NOTE:** This step requires working internet connection.
![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:
* Grant access to your contacts, if you want to use the contacts on your device (optional)
* Disable battery optimization (highly recommended to ensure the app works in the background)
## 6. (Unified) Inbox
Once you press the back button, you'll enter your new inbox. At first, you will see a pop-up message with important information.
For your better understanding, there will be additional information you can dismiss by tapping on the "X".
Please read them as they will help you in understanding how the app works and how to get support.
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.
If you still would like to change the settings, just take time looking around the available options. You can also search through available settings.
The most common three settings you might want to set on the first run are mentioned below.
Apart from that, there's also [this separate manual describing various settings / options](/settings-overview.md) in FairEmail.
### 1. Disable the permanent notification (watchdog)
The watchdog 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).
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:
1. Open the menu by tapping the three dashes in the top left corner (hamburger menu)
2. Choose "Settings"
3. At the top bar, select the tab called "Display"
4. Go to the option "Show on start screen" and select an available option within the dropdown menu
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:
1. Open the menu by tapping the three dashes in the top left corner (hamburger menu)
2. Choose "Settings"
3. At the top bar, select the tab called "Display"
4. Press the "Select theme" button
5. Select the theme of your choice and confirm
**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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

@ -0,0 +1,2 @@
# TODO
This manual does not exist yet. It is to be added at a later time.

@ -0,0 +1,15 @@
# 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 [this extensive FAQ](https://github.com/M66B/FairEmail/blob/master/FAQ.md).
The manuals here will only cover the basics that should suffice for most users.
**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 email to [marcel@faircode.eu](mailto:marcel@faircode.eu). Bad reviews won't help you or the developer, so try asking in person first.
## Table of Contents
* [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)

@ -0,0 +1,154 @@
# 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.
**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 email to [marcel@faircode.eu](mailto:marcel@faircode.eu). Bad reviews won't help you or the developer, so try asking in person first.
**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.
You will now find multiple categories:
* **Main** - To add a new account
* **Receive** - To adjust the synchronizing and checking of incoming mails
* **Send** - Options related to writing and sending an email
* **Connection** - Options related to using your internet connection and downloading messages
* **Display** - To adjust how the app and the messages look like
* **Behavior** - To adjust how the app should behave
* **Privacy** - To enable / disable options that increase your privacy
* **Encryption** - Options related to encrypted messaging (PGP & S/MIME)
* **Notifications** - Options related to the notifications by FairEmail
* **Miscellaneous** - Some other options such as error reporting
## Table of Contents
* [1. Adding a new Account](#1-adding-a-new-account)
* [2. Receiving Messages in the Daytime only](#2-receiving-messages-in-the-daytime-only)
* [3. Enable Checking for Spam](#3-enable-checking-for-spam)
* [4. Edit Your E-Mail Signature](#4-edit-your-e-mail-signature)
* [5. Limit Mobile Data Usage](#5-limit-mobile-data-usage)
* [6. Changing the Theme](#6-changing-the-theme)
* [7. Changing Start Screen](#7-changing-start-screen)
* [8. Show an Avatar for each Sender](#8-show-an-avatar-for-each-sender)
* [9. Enable Biometric Authentication](#9-enable-biometric-authentication)
* [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-condig.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
2. Enable the option "Schedule"
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:
1. Go to the "Main" settings
2. Click on "Manual setup and account options" below the wizard
3. Press the "Accounts" button
4. Select the account
5. Scroll down until you find the "Advanced" options (gear icon) and press the button
6. Enable the option "Synchronize outside the schedule too"
## 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
2. Scroll down to "Checks"
3. Enable the option "Check if the sender's domain name is on a spam block list"
**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 E-Mail 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:
1. Go to the "Main" settings
2. Click on "Manual setup and account options" below the wizard
3. Press the "Identities" button
4. Press the "Edit signature" button
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.
Go to the "Connection" settings and you will find the following "General" options:
* Use metered connections - using mobile data and paid Wi-Fi hotspots
* Download while roaming
* Roam like at home - Roaming within the EU won't be considered as roaming
More information 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:
1. Open the menu by tapping the three dashes in the top left corner (hamburger menu)
2. Choose "Settings"
3. At the top bar, select the tab called "Display"
4. Press the "Select theme" button
5. Select the theme of your choice and confirm
**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.
## 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:
1. Open the menu by tapping the three dashes in the top left corner (hamburger menu)
2. Choose "Settings"
3. At the top bar, select the tab called "Display"
4. Go to the option "Show on start screen" and select an available option within the dropdown menu
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
2. Scroll down to the "Message header" section
3. Enable the options of your choice
**NOTE:** Apart from the generated icons, there might be a privacy risk with each available option.
Gravatars and Libravatar might not be available in the PlayStore version as Google falsely flags the app to be a spyware otherwise.
## 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:
1. Go to the "Privacy" settings
2. Press on the "PIN" or "Enable fingerprint" button
3. Follow the instruction on your screen
## 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:
1. Go to the "Miscellaneous" settings
2. Enable the option "Send error reports"
More information in [FAQ #104 What do I need to know about error reporting?](https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq104).
Loading…
Cancel
Save