From 256c4ad0cad9c458bb4d88d48016c86bfa16a939 Mon Sep 17 00:00:00 2001 From: Luke Date: Sun, 18 Jul 2021 18:23:14 +0100 Subject: [PATCH] Base: Add man page for Mail This is primarily used to give an example configuration file. --- Base/usr/share/man/man1/Mail.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 Base/usr/share/man/man1/Mail.md diff --git a/Base/usr/share/man/man1/Mail.md b/Base/usr/share/man/man1/Mail.md new file mode 100644 index 0000000000..c63ac32d86 --- /dev/null +++ b/Base/usr/share/man/man1/Mail.md @@ -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 +```