[#6838] Use the headers Reply-to value if its set in the extensions

amercader · amercader · commit 499ce5a7fe50 · 2022-08-25T11:43:51.000+02:00
diff --git a/ckan/lib/mailer.py b/ckan/lib/mailer.py
@@ -59,7 +59,8 @@ def _mail_recipient(recipient_name, recipient_email,
     msg['To'] = u"%s <%s>" % (recipient_name, recipient_email)
     msg['Date'] = utils.formatdate(time())
     msg['X-Mailer'] = "CKAN %s" % ckan.__version__
-    if reply_to and reply_to != '':
+    # Check if extension is setting reply-to via headers or use config option
+    if reply_to and reply_to != '' and not msg['Reply-to']:
         msg['Reply-to'] = reply_to
 
     # Send the email using Python's smtplib.
diff --git a/ckan/tests/lib/test_mailer.py b/ckan/tests/lib/test_mailer.py
@@ -281,3 +281,27 @@ def test_reply_to(self, mail_server):
         )
 
         assert expected_from_header in msg[3]
+
+    @pytest.mark.ckan_config("smtp.reply_to", "norply@ckan.org")
+    def test_reply_to_ext_headers_overwrite(self, mail_server):
+
+        msgs = mail_server.get_smtp_messages()
+        assert msgs == []
+
+        # send email
+        test_email = {
+            "recipient_name": "Bob",
+            "recipient_email": "Bob@bob.com",
+            "subject": "Meeting",
+            "body": "The meeting is cancelled.",
+            "headers": {"Reply-to": "norply@ckanext.org"},
+        }
+        mailer.mail_recipient(**test_email)
+
+        # check it went to the mock smtp server
+        msgs = mail_server.get_smtp_messages()
+        msg = msgs[0]
+
+        expected_from_header = 'Reply-to: norply@ckanext.org'
+
+        assert expected_from_header in msg[3]
