changeset 8751:ad239692ea95

mail: fix duplicate "From" headers Problem introduced in 9a0c41175e66: When iterating the headers dict and setting "msg[key] = value", it wasn't replacing the header but performing add_header so we sometimes ended up with two From headers. It is also a general problem that while the headers dict only can contain each key once, it can contain entries that only differ in casing and thus will fold to the same message header, making it possible to end up adding duplicate headers. "msg.replace_header(key, value)" is not a simple solution to the problem: it will raise KeyError if no such previous key exists. Now, make the problem more clear by explicitly using add_header. Avoid the duplication problem by deleting the key (no matter which casing) before invoking add_header. Delete promises that "No exception is raised if the named field isn’t present in the headers".
author Mads Kiilerich <mads@kiilerich.com>
date Wed, 04 Nov 2020 00:35:21 +0100
parents d913d84d5253
children 8bba2d253187
files kallithea/lib/celerylib/tasks.py
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/kallithea/lib/celerylib/tasks.py	Wed Nov 04 21:11:48 2020 +0100
+++ b/kallithea/lib/celerylib/tasks.py	Wed Nov 04 00:35:21 2020 +0100
@@ -317,7 +317,8 @@
     msg['Date'] = email.utils.formatdate(time.time())
 
     for key, value in headers.items():
-        msg[key] = value
+        del msg[key]  # Delete key first to make sure add_header will replace header (if any), no matter the casing
+        msg.add_header(key, value)
 
     msg.attach(email.mime.text.MIMEText(body, 'plain'))
     msg.attach(email.mime.text.MIMEText(html_body, 'html'))