From 9ac78ef95930a7c6acd42a955bf5b0d87a6b169a Mon Sep 17 00:00:00 2001
From: polistern <polistern@i2pmail.org>
Date: Fri, 19 Nov 2021 09:20:55 +0000
Subject: [PATCH] Added how to about SMTP and POP3 usage.

---
 .gitignore => docs/.gitignore      |  0
 docs/docs/tutorials/POP3.md        |  3 ++
 docs/docs/tutorials/SMTP.md        | 50 ++++++++++++++++++++++++++++++
 docs/docs/tutorials/mail_client.md | 27 ++++++++++++++++
 docs/mkdocs.yml                    |  1 +
 5 files changed, 81 insertions(+)
 rename .gitignore => docs/.gitignore (100%)
 create mode 100644 docs/docs/tutorials/mail_client.md

diff --git a/.gitignore b/docs/.gitignore
similarity index 100%
rename from .gitignore
rename to docs/.gitignore
diff --git a/docs/docs/tutorials/POP3.md b/docs/docs/tutorials/POP3.md
index babfcff..ed8be92 100644
--- a/docs/docs/tutorials/POP3.md
+++ b/docs/docs/tutorials/POP3.md
@@ -1,5 +1,7 @@
 # POP3
 
+_Tested with [Mozilla Thunderbird](https://www.thunderbird.net/en-US/)_
+
 To be able to receive email through POP3 you need to:
 
 - Fill [pop3] section in configuration file:
@@ -13,3 +15,4 @@ port = 110
 
 - Restart the **pboted** to apply the settings
 - After loading, you be able to connect to the specified POP3 port manually or with your mail client.
+
diff --git a/docs/docs/tutorials/SMTP.md b/docs/docs/tutorials/SMTP.md
index d08b633..92121f9 100644
--- a/docs/docs/tutorials/SMTP.md
+++ b/docs/docs/tutorials/SMTP.md
@@ -1,5 +1,7 @@
 # SMTP
 
+_Tested with [Mozilla Thunderbird](https://www.thunderbird.net/en-US/)_
+
 To be able to send email through SMTP you need to:
 
 - Fill [smtp] section in configuration file:
@@ -13,3 +15,51 @@ port = 25
 
 - Restart the **pboted** to apply the settings
 - After loading, you be able to connect to the specified SMTP port manually or with your mail client.
+
+## How to compose email
+
+### FROM
+
+There are 2 options for how this field might look.
+
+#### 1. classic
+
+In this case, the address consists of three parts, something like this:
+
+`NAME <IDENTITY_NAME@DOMAIN>`
+
+The NAME part is optional.   
+The IDENTITY_NAME part should be the name of the used Bote identity.   
+The DOMAIN part can be any valid domain.
+
+For example:
+
+`John Doe <johnd@bote.i2p>`
+
+#### 2. Bote style
+
+In this case, the address consists of two parts, something like this:
+
+`IDENTITY_NAME <BOTE_ADDRESS>`
+
+The IDENTITY_NAME part should be the name of the used Bote identity.   
+The BOTE_ADDRESS part should be Bote address.
+
+For example:
+
+`johnd <24noEIMPvV9CEwrSWQtIsTA7balaZ80ZOGRBAzrsBl5nv9xud~k28d9TQIgXmyyCYtHl8PJASAFDeefSc6EJ81>`
+
+### TO
+
+Very similar to field FROM with one amendment for option 1:   
+The <IDENTITY_NAME@DOMAIN> must be in the address book for replacement.
+
+For example, if you have this record in addressbook:
+
+```
+johnd1@bote.i2p;John Doe 1;24noEIMPvV9CEwrSWQtIsTA7balaZ80ZOGRBAzrsBl5nv9xud~k28d9TQIgXmyyCYtHl8PJASAFDeefSc6EJ81
+```
+
+You can fill TO like this:
+
+`TO: John Doe <johnd1@bote.i2p>`
diff --git a/docs/docs/tutorials/mail_client.md b/docs/docs/tutorials/mail_client.md
new file mode 100644
index 0000000..88342c8
--- /dev/null
+++ b/docs/docs/tutorials/mail_client.md
@@ -0,0 +1,27 @@
+# Configuring the mail client
+
+_Tested with [Mozilla Thunderbird](https://www.thunderbird.net/en-US/)_
+
+## SMTP
+
+1. Turn on SMTP for [this](SMTP.md) instruction.
+2. For default settings client side configuration looks like:
+
+- Server name: localhost
+- Port: 25
+- Connection security: None
+- Authentication method: No authentication
+- User Name: username
+
+## POP3
+
+1. Turn on POP3 for [this](POP3.md) instruction.
+2. For default settings client side configuration looks like:
+
+- Server name: localhost
+- Port: 110
+- Connection security: None
+- Authentication method: Password, transmitted insecurely
+
+For now, you can use any password, as it will be ignored on the pboted side.
+ 
\ No newline at end of file
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 94f7eb4..fb03b97 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -18,6 +18,7 @@ nav:
   - AddressBook: tutorials/addressbook.md
   - SMTP: tutorials/SMTP.md
   - POP3: tutorials/POP3.md
+  - Configuring the mail client: tutorials/mail_client.md
 - Developer Section:
   - Building from source:
     - Requirements: devs/building/requirements.md