Base: Add man page for Mail

This is primarily used to give an example configuration file.
This commit is contained in:
Luke 2021-07-18 18:23:14 +01:00 committed by Ali Mohammad Pur
parent b716e902ba
commit 256c4ad0ca
Notes: sideshowbarker 2024-07-18 08:24:10 +09:00

View file

@ -0,0 +1,33 @@
## Name
Mail - Serenity e-mail client
## Synopsis
```**sh
$ Mail
```
## Description
Mail is an e-mail client for Serenity. It can connect to real e-mail servers.
Currently, a configuration file is required. This must be stored in `~/.config/Mail.ini`
See the Examples section for an example configuration file.
## Examples
`~/.config/Mail.ini`:
```ini
[Connection]
Server=email.example.com
Port=993
TLS=true
[User]
Username=test@example.com
Password=Example1
```
```sh
$ Mail
```