Merge: #1525919: Document MIMEText+set_payload encoding behavior.

This commit is contained in:
R David Murray 2013-03-19 18:21:22 -04:00
commit 432a48a0c8
1 changed files with 10 additions and 0 deletions

View File

@ -187,3 +187,13 @@ Here are the classes:
:class:`~email.mime.nonmultipart.MIMENonMultipart` constructor; it defaults :class:`~email.mime.nonmultipart.MIMENonMultipart` constructor; it defaults
to ``us-ascii`` if the string contains only ``ascii`` codepoints, and to ``us-ascii`` if the string contains only ``ascii`` codepoints, and
``utf-8`` otherwise. ``utf-8`` otherwise.
Unless the ``_charset`` parameter is explicitly set to ``None``, the
MIMEText object created will have both a :mailheader:`Content-Type` header
with a ``charset`` parameter, and a :mailheader:`Content-Transfer-Endcoding`
header. This means that a subsequent ``set_payload`` call will not result
in an encoded payload, even if a charset is passed in the ``set_payload``
command. You can "reset" this behavior by deleting the
``Content-Transfer-Encoding`` header, after which a ``set_payload`` call
will automatically encode the new payload (and add a new
:mailheader:`Content-Transfer-Encoding` header).