summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.encoders.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2016-09-08 01:15:59 (GMT)
committerR David Murray <rdmurray@bitdance.com>2016-09-08 01:15:59 (GMT)
commit29d1bc0842e5b086813aa7de4ab18f1c192d2291 (patch)
treeb812609f72f860adb5203ba9cbb1d0c4299e39af /Doc/library/email.encoders.rst
parent23e863378124229928e12b72c22df33f1428c61e (diff)
downloadcpython-29d1bc0842e5b086813aa7de4ab18f1c192d2291.zip
cpython-29d1bc0842e5b086813aa7de4ab18f1c192d2291.tar.gz
cpython-29d1bc0842e5b086813aa7de4ab18f1c192d2291.tar.bz2
#24277: The new email API is no longer provisional.
This is a wholesale reorganization and editing of the email documentation to make the new API the standard one, and the old API the 'legacy' one. The default is still the compat32 policy, for backward compatibility. We will change that eventually.
Diffstat (limited to 'Doc/library/email.encoders.rst')
-rw-r--r--Doc/library/email.encoders.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst
index 9d7f9bf..e24ac7b 100644
--- a/Doc/library/email.encoders.rst
+++ b/Doc/library/email.encoders.rst
@@ -8,6 +8,12 @@
--------------
+This module is part of the legacy (``Compat32``) email API. In the
+new API the functionality is provided by the *cte* parameter of
+the :meth:`~email.message.EmailMessage.set_content` method.
+
+The remaining text in this section is the original documentation of the module.
+
When creating :class:`~email.message.Message` objects from scratch, you often
need to encode the payloads for transport through compliant mail servers. This
is especially true for :mimetype:`image/\*` and :mimetype:`text/\*` type messages