aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar maTh <math-home@web.de> 2022-08-29 08:38:35 +0200
committerGravatar GitHub <noreply@github.com> 2022-08-29 08:38:35 +0200
commit10f29a736221a41549f9ab1de70e0c4d593958c7 (patch)
treedc70fb3288468f5d7a7674091a9d3d2f4b1bd87f /docs
parent5e3f2a4ad53df1bacfb03c2499c19e36a020de2a (diff)
Improve documentation: example code to configure SMTP (#4555)
* add example code * just a changed line break * fix * Fix Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Diffstat (limited to 'docs')
-rw-r--r--docs/en/admins/05_Configuring_email_validation.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/en/admins/05_Configuring_email_validation.md b/docs/en/admins/05_Configuring_email_validation.md
index 500a2b5aa..69a06b53f 100644
--- a/docs/en/admins/05_Configuring_email_validation.md
+++ b/docs/en/admins/05_Configuring_email_validation.md
@@ -26,12 +26,29 @@ To configure a SMTP server, you’ll have to modify the `data/config.php` file.
First, change the `mailer` item to `smtp` (instead of the default `mail`).
-Then, you should change the `smtp` options like you would do with a regular
-email client. You can find the full list of options in the [`config.default.php` file](https://github.com/FreshRSS/FreshRSS/blob/edge/config.default.php).
+Then, you should change the `smtp` options like you would do with a regular email client.
+You can find the full list of options in the [`config.default.php` file](https://github.com/FreshRSS/FreshRSS/blob/edge/config.default.php).
If you’re not sure to what each item is corresponding, you may find useful [the
PHPMailer documentation](http://phpmailer.github.io/PHPMailer/classes/PHPMailer.PHPMailer.PHPMailer.html#properties)
(which is used by FreshRSS under the hood).
+### Example code to configure SMTP server
+
+```php
+ 'mailer' => 'smtp', // instead of 'mail'
+ 'smtp' => array(
+ 'hostname' => 'example.net',
+ 'host' => 'smtp.example.net', // URL to your smtp server
+ 'port' => 465,
+ 'auth' => true,
+ 'auth_type' => '',
+ 'username' => 'alice', // or maybe alice@example.net
+ 'password' => 'yoursecretpassword',
+ 'secure' => 'ssl', // '', 'ssl' or 'tls'
+ 'from' => 'alice@example.net',
+ ),
+```
+
## Check your SMTP server is correctly configured
To do so, once you’ve enabled the `force_email_validation` option, you only