[Python-checkins] cpython: #24211: Add missing docs for SMTPUTF8 policy instance.

[r.david.murray]

https://hg.python.org/cpython/rev/4a254750ad20
changeset:   96127:4a254750ad20
user:        R David Murray <rdmurray at bitdance.com>
date:        Sun May 17 19:36:16 2015 -0400
summary:
  #24211: Add missing docs for SMTPUTF8 policy instance.

files:
  Doc/library/email.policy.rst |  8 ++++++++
  1 files changed, 8 insertions(+), 0 deletions(-)


diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst
--- a/Doc/library/email.policy.rst
+++ b/Doc/library/email.policy.rst
@@ -534,6 +534,14 @@
    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

-- 
Repository URL: https://hg.python.org/cpython