summaryrefslogtreecommitdiff
path: root/Doc/library/email.encoders.rst
diff options
context:
space:
mode:
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 9d7f9bf5e9..e24ac7b90d 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