Attempt to generate more human-readable addresses in email

Author: Richard Jones

CHANGES.txt

@@ -25,6 +25,8 @@ Fixes:
 - Display 'today' in the account user's timezone, thanks David Wolever
 - Fix file handle leak in some web interfaces with logging turned on,
   fixes issue1675845
+- Attempt to generate more human-readable addresses in email, fixes
+  issue2550632
 
 
 2009-12-21 1.4.11 (r4413)

roundup/mailer.py

@@ -9,7 +9,7 @@
 from roundup import __version__
 from roundup.date import get_timezone
 
-from email.Utils import formatdate, formataddr
+from email.Utils import formatdate, formataddr, specialsre, escapesre
 from email.Message import Message
 from email.Header import Header
 from email.MIMEText import MIMEText
@@ -25,6 +25,21 @@ def encode_quopri(msg):
     del msg['Content-Transfer-Encoding']
     msg['Content-Transfer-Encoding'] = 'quoted-printable'
 
+def nice_sender_header(name, address, charset):
+    # construct an address header so it's as human-readable as possible
+    # even in the presence of a non-ASCII name part
+    h = Header(charset=charset)
+    # the important bits of formataddr()
+    if specialsre.search(name):
+        name = '"%s"'%escapesre.sub(r'\\\g<0>', name)
+    try:
+        name.encode('ASCII')
+        h.append(name, 'ASCII')
+    except UnicodeEncodeError:
+        h.append(name)
+    h.append('<%s>'%address, 'ASCII')
+    return str(h)
+
 class Mailer:
     """Roundup-specific mail sending."""
     def __init__(self, config):
@@ -65,11 +80,7 @@ def get_standard_message(self, to, subject, author=None, multipart=False):
             name = author[0]
         else:
             name = unicode(author[0], 'utf-8')
-        try:
-            name = name.encode('ascii')
-        except UnicodeError:
-            name = Header(name, charset).encode()
-        author = formataddr((name, author[1]))
+        author = nice_sender_header(name, author[1], charset)
 
         if multipart:
             message = MIMEMultipart()

roundup/roundupdb.py

@@ -35,7 +35,8 @@
 from roundup.i18n import _
 
 # MessageSendError is imported for backwards compatibility
-from roundup.mailer import Mailer, MessageSendError, encode_quopri
+from roundup.mailer import Mailer, MessageSendError, encode_quopri, \
+    nice_sender_header
 
 class Database:
 
@@ -406,9 +407,10 @@ def send_message(self, nodeid, msgid, note, sendto, from_address=None,
         else:
             sendto = [sendto]
 
+        # tracker sender info
         tracker_name = unicode(self.db.config.TRACKER_NAME, 'utf-8')
-        tracker_name = formataddr((tracker_name, from_address))
-        tracker_name = Header(tracker_name, charset)
+        tracker_name = nice_sender_header(tracker_name, from_address,
+            charset)
 
         # now send one or more messages
         # TODO: I believe we have to create a new message each time as we

test/test_mailer.py

@@ -0,0 +1,24 @@
+#-*- encoding: utf8 -*-
+import unittest
+
+from roundup import mailer
+
+class EncodingTestCase(unittest.TestCase):
+    def test(self):
+        a = lambda n, a, c, o: self.assertEquals(mailer.nice_sender_header(n,
+            a, c), o)
+        a('ascii', '[email protected]', 'latin1', 'ascii <[email protected]>')
+        a(u'café', '[email protected]', 'latin1',
+            '=?latin1?q?caf=E9?= <[email protected]>')
+        a('as"ii', '[email protected]', 'latin1', '"as\\"ii" <[email protected]>')
+
+def test_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(EncodingTestCase))
+    return suite
+
+if __name__ == '__main__':
+    runner = unittest.TextTestRunner()
+    unittest.main(testRunner=runner)
+
+# vim: set et sts=4 sw=4 :