Skip to content

Commit 68536b4

Browse files
Update Email Notifications
1 parent 69e40a8 commit 68536b4

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

email_notifications.rst

+39-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,50 @@
11
.. _smarthost-section:
22

3+
.. _email-notifications:
4+
35
===================
46
Email notifications
57
===================
68

7-
Many applications require access to an SMTP server to send mail.
9+
Many applications, such as Nextcloud and Mattermost, require SMTP server
10+
configuration to send notification messages to users and service
11+
administrators.
812

913
You can configure the same SMTP server for all installed applications by
1014
accessing the ``Email notifications`` card inside the ``Settings`` page.
1115

12-
Then, enable the feature by clicking on ``Send notifications with an SMTP
16+
To enable the feature, click on ``Send notifications with an SMTP
1317
server`` and fill the required details.
18+
19+
If a Mail application instance is already installed in the cluster, choose
20+
the ``Use Mail app instance`` option. Then refer to the section
21+
:ref:`relay-rules-section` for further information about the configuration
22+
of Mail.
23+
24+
Instead, choose ``Manual configuration`` to specify SMTP server parameters
25+
in this form. Available fields are:
26+
27+
- **SMTP server**: The host name or IP address of the SMTP server
28+
29+
- **SMTP port number**: TCP port number of the server. Common values are
30+
587, 25, 465, 2525.
31+
32+
- **SMTP encryption**: Encryption used by the server. TLS is a widely used
33+
encryption protocol that encrypts a connection from the moment it is
34+
established. STARTTLS is the standard encryption method for SMTP. If
35+
both the client and server support it, the connection is encrypted after
36+
both sides agree to use it.
37+
38+
- **Verify the TLS certificate**: If encryption is used, this switch
39+
controls if the certificate used to encrypt the connection must be
40+
signed by a trusted authority or not. If the server presents a
41+
self-signed certificate, turn off this switch to accept it.
42+
43+
- **Username** and **Password**: If the server requires SMTP
44+
authentication, fill the credential fields; otherwise leave them blank.
45+
46+
After saving the settings, a SMTP connection to validate the form
47+
parameters is immediately started. In some cases, validation is
48+
successful, but messages may still fail to be delivered. It is recommended
49+
to check that individual applications can successfully send messages with
50+
the new settings.

0 commit comments

Comments
 (0)