]> granicus.if.org Git - python/commitdiff
#24211: Add missing docs for SMTPUTF8 policy instance.
authorR David Murray <rdmurray@bitdance.com>
Sun, 17 May 2015 23:36:16 +0000 (19:36 -0400)
committerR David Murray <rdmurray@bitdance.com>
Sun, 17 May 2015 23:36:16 +0000 (19:36 -0400)
Doc/library/email.policy.rst

index 6e1318672bdfdb6636bf2cb2919c58573d6aa5aa..045b11930305e8bc5ffa8308a63812f251a1036a 100644 (file)
@@ -534,6 +534,14 @@ more closely to the RFCs relevant to their domains.
    Like ``default``, but with ``linesep`` set to ``\r\n``, which is RFC
    compliant.
 
+.. data:: SMTPUTF8
+
+   The same as ``SMTP`` except that :attr:`~EmailPolicy.utf8` is ``True``.
+   Useful for serializing messages to a message store without using encoded
+   words in the headers.  Should only be used for SMTP trasmission if the
+   sender or recipient addresses have non-ASCII characters (the
+   :meth:`smtplib.SMTP.send_message` method handles this automatically).
+
 .. data:: HTTP
 
    Suitable for serializing headers with for use in HTTP traffic.  Like