summary refs log tree commit diff
path: root/synapse/handlers/send_email.py
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-09-30 14:23:37 +0100
committerGitHub <noreply@github.com>2022-09-30 13:23:37 +0000
commit5507bfa769e61f5ef507c6172b8e798a87ac84b1 (patch)
treec09b394d682fc051d0de8669c1a7a2bf485cbd69 /synapse/handlers/send_email.py
parentAdd some cross references to worker documentation (#13974) (diff)
downloadsynapse-5507bfa769e61f5ef507c6172b8e798a87ac84b1.tar.xz
Discourage automatic replies to Synapse's emails (#13957)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'synapse/handlers/send_email.py')
-rw-r--r--synapse/handlers/send_email.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/synapse/handlers/send_email.py b/synapse/handlers/send_email.py
index e2844799e8..804cc6e81e 100644
--- a/synapse/handlers/send_email.py
+++ b/synapse/handlers/send_email.py
@@ -187,6 +187,19 @@ class SendEmailHandler:
         multipart_msg["To"] = email_address
         multipart_msg["Date"] = email.utils.formatdate()
         multipart_msg["Message-ID"] = email.utils.make_msgid()
+        # Discourage automatic responses to Synapse's emails.
+        # Per RFC 3834, automatic responses should not be sent if the "Auto-Submitted"
+        # header is present with any value other than "no". See
+        #     https://www.rfc-editor.org/rfc/rfc3834.html#section-5.1
+        multipart_msg["Auto-Submitted"] = "auto-generated"
+        # Also include a Microsoft-Exchange specific header:
+        #    https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcmail/ced68690-498a-4567-9d14-5c01f974d8b1
+        # which suggests it can take the value "All" to "suppress all auto-replies",
+        # or a comma separated list of auto-reply classes to suppress.
+        # The following stack overflow question has a little more context:
+        #    https://stackoverflow.com/a/25324691/5252017
+        #    https://stackoverflow.com/a/61646381/5252017
+        multipart_msg["X-Auto-Response-Suppress"] = "All"
         multipart_msg.attach(text_part)
         multipart_msg.attach(html_part)