Document default account configuration

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

1 files changed, 46 insertions, 0 deletions

diff --git a/doc/admin.md b/doc/admin.md
index fbbc86128..cf1067c4a 100644
--- a/doc/admin.md
+++ b/doc/admin.md
@@ -11,6 +11,52 @@ Then open the Mail app from the app menu. Put in your mail account credentials a
 
 Certain advanced or experimental features need to be specifically enabled in your `config.php`:
 
+### Automatic account creation
+
+In cases where an external user back-end is used for both your Nextcloud and your mail server you may want to have imap accounts set up automatically for your users.
+
+### Available patterns
+
+Two patterns are available to automatically construct credentials:
+* `%USERID%`, e.g. `jan`
+* `%EMAIL%`, e.g. `jan@domain.tld`
+
+### Minimal configuration
+
+The following minimal configuration will add such an account as soon as the user logs in. The login password is used for the IMAP and SMTP authentication.
+
+Note: Valid values for SSL are `'none'`, `'ssl'` and `'tls'`.
+
+```
+  'app.mail.accounts.default' => [
+    'email' => '%USERID%@domain.tld',
+    'imapHost' => 'imap.domain.tld',
+    'imapPort' => 993,
+    'imapSslMode' => 'ssl',
+    'smtpHost' => 'smtp.domain.tld',
+    'smtpPort' => 486,
+    'smtpSslMode' => 'tls',
+  ],
+```
+
+### Advanced configuration
+
+In case you have to tweak IMAP and SMTP username, you can do that too.
+
+```
+  'app.mail.accounts.default' => [
+    'email' => '%USERID%@domain.tld',
+    'imapHost' => 'imap.domain.tld',
+    'imapPort' => 993,
+    'imapUser' => '%USERID%@domain.tld',
+    'imapSslMode' => 'ssl',
+    'smtpHost' => 'smtp.domain.tld',
+    'smtpPort' => 486,
+    'smtpUser' => '%USERID%@domain.tld',
+    'smtpSslMode' => 'tls',
+  ],
+```
+
 ### Timeouts
 Depending on your mail host, it may be necessary to increase your IMAP and/or SMTP timeout threshold. Currently IMAP defaults to 20 seconds and SMTP defaults to 2 seconds. They can be changed as follows: