summary refs log tree commit diff
path: root/synapse/config/emailconfig.py
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-11-28 09:29:18 +0000
committerGitHub <noreply@github.com>2019-11-28 09:29:18 +0000
commitc48ea9800769c22d763cd97ecb137141050739e1 (patch)
treec4bbf8046b58e7d208694d2f2027e322acc504ff /synapse/config/emailconfig.py
parentImplementation of MSC2314 (#6176) (diff)
downloadsynapse-c48ea9800769c22d763cd97ecb137141050739e1.tar.xz
Clarifications for the email configuration settings. (#6423)
Cf #6422
Diffstat (limited to '')
-rw-r--r--synapse/config/emailconfig.py17
1 files changed, 16 insertions, 1 deletions
diff --git a/synapse/config/emailconfig.py b/synapse/config/emailconfig.py
index ac1724045f..18f42a87f9 100644
--- a/synapse/config/emailconfig.py
+++ b/synapse/config/emailconfig.py
@@ -307,8 +307,23 @@ class EmailConfig(Config):
         #   smtp_user: "exampleusername"
         #   smtp_pass: "examplepassword"
         #   require_transport_security: false
+        #
+        #   # notif_from defines the "From" address to use when sending emails.
+        #   # It must be set if email sending is enabled.
+        #   #
+        #   # The placeholder '%(app)s' will be replaced by the application name,
+        #   # which is normally 'app_name' (below), but may be overridden by the
+        #   # Matrix client application.
+        #   #
+        #   # Note that the placeholder must be written '%(app)s', including the
+        #   # trailing 's'.
+        #   #
         #   notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
-        #   app_name: Matrix
+        #
+        #   # app_name defines the default value for '%(app)s' in notif_from. It
+        #   # defaults to 'Matrix'.
+        #   #
+        #   #app_name: my_branded_matrix_server
         #
         #   # Enable email notifications by default
         #   #