diff -r a7e0a1dbfbb6 Doc/library/email.util.rst --- a/Doc/library/email.util.rst Sun Mar 27 10:15:57 2011 +0200 +++ b/Doc/library/email.util.rst Mon Mar 28 11:49:31 2011 +0200 @@ -29,13 +29,18 @@ fails, in which case a 2-tuple of ``('', '')`` is returned. -.. function:: formataddr(pair) +.. function:: formataddr(pair, charset='utf-8') The inverse of :meth:`parseaddr`, this takes a 2-tuple of the form ``(realname, email_address)`` and returns the string value suitable for a :mailheader:`To` or :mailheader:`Cc` header. If the first element of *pair* is false, then the second element is returned unmodified. + Optional *charset* if given this is the character set that is used to encode + ``realname`` in case ``realname`` is not ASCII safe. Can be an instance of + :class:`str` or a :class:`Charset`-like object which has a :meth:`header_encode` + method. + .. function:: getaddresses(fieldvalues) diff -r a7e0a1dbfbb6 Lib/email/utils.py --- a/Lib/email/utils.py Sun Mar 27 10:15:57 2011 +0200 +++ b/Lib/email/utils.py Mon Mar 28 11:49:31 2011 +0200 @@ -42,6 +42,7 @@ # Intrapackage imports from email.encoders import _bencode, _qencode +from email.charset import Charset COMMASPACE = ', ' EMPTYSTRING = '' @@ -56,21 +57,36 @@ # Helpers -def formataddr(pair): +def formataddr(pair, charset='utf-8'): """The inverse of parseaddr(), this takes a 2-tuple of the form (realname, email_address) and returns the string value suitable for an RFC 2822 From, To or Cc header. If the first element of pair is false, then the second element is returned unmodified. + + Optional charset if given this is the character set that is used + to encode realname in case realname is not ASCII safe. Can be an + instance of str or a Charset-like object which has a header_encode + method. """ name, address = pair + # Will throw UnicodeEncodeError when address is not plain ascii: + address.encode('ascii') if name: - quotes = '' - if specialsre.search(name): - quotes = '"' - name = escapesre.sub(r'\\\g<0>', name) - return '%s%s%s <%s>' % (quotes, name, quotes, address) + try: + name.encode('ascii') + except UnicodeEncodeError: + if isinstance(charset, str): + charset = Charset(charset) + encoded_name = charset.header_encode(name) + return "%s <%s>" % (encoded_name, address) + else: + quotes = '' + if specialsre.search(name): + quotes = '"' + name = escapesre.sub(r'\\\g<0>', name) + return '%s%s%s <%s>' % (quotes, name, quotes, address) return address diff -r a7e0a1dbfbb6 Lib/test/test_email/test_email.py --- a/Lib/test/test_email/test_email.py Sun Mar 27 10:15:57 2011 +0200 +++ b/Lib/test/test_email/test_email.py Mon Mar 28 11:49:31 2011 +0200 @@ -2408,6 +2408,46 @@ b = 'person@dom.ain' self.assertEqual(utils.parseaddr(utils.formataddr((a, b))), (a, b)) + def test_quotes_unicode_names(self): + # issue 1690608. email.utils.formataddr() should be rfc2047 aware. + name = "H\u00e4ns W\u00fcrst" + addr = 'person@dom.ain' + utf8_base64 = "=?utf-8?b?SMOkbnMgV8O8cnN0?= " + latin1_quopri = "=?iso-8859-1?q?H=E4ns_W=FCrst?= " + self.assertEqual(utils.formataddr((name, addr)), utf8_base64) + self.assertEqual(utils.formataddr((name, addr), 'iso-8859-1'), + latin1_quopri) + + def test_accepts_any_charset_like_object(self): + # issue 1690608. email.utils.formataddr() should be rfc2047 aware. + name = "H\u00e4ns W\u00fcrst" + addr = 'person@dom.ain' + utf8_base64 = "=?utf-8?b?SMOkbnMgV8O8cnN0?= " + foobar = "FOOBAR" + class CharsetMock: + def header_encode(self, string): + return foobar + mock = CharsetMock() + mock_expected = "%s <%s>" % (foobar, addr) + self.assertEqual(utils.formataddr((name, addr), mock), mock_expected) + self.assertEqual(utils.formataddr((name, addr), Charset('utf-8')), + utf8_base64) + + def test_invalid_charset_like_object_raises_error(self): + # issue 1690608. email.utils.formataddr() should be rfc2047 aware. + name = "H\u00e4ns W\u00fcrst" + addr = 'person@dom.ain' + # A object without a header_encode method: + bad_charset = object() + self.assertRaises(AttributeError, utils.formataddr, (name, addr), + bad_charset) + + def test_unicode_address_raises_error(self): + # issue 1690608. email.utils.formataddr() should be rfc2047 aware. + addr = 'pers\u00f6n@dom.in' + self.assertRaises(UnicodeError, utils.formataddr, (None, addr)) + self.assertRaises(UnicodeError, utils.formataddr, ("Name", addr)) + def test_name_with_dot(self): x = 'John X. Doe ' y = '"John X. Doe" ' diff -r a7e0a1dbfbb6 Misc/ACKS --- a/Misc/ACKS Sun Mar 27 10:15:57 2011 +0200 +++ b/Misc/ACKS Mon Mar 28 11:49:31 2011 +0200 @@ -977,3 +977,4 @@ Kai Zhu Tarek Ziadé Peter Åstrand +Torsten Becker