Skip to content

Commit a747c3a

Browse files
authored
bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)
1 parent a6ec1ce commit a747c3a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Doc/library/email.encoders.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ This module is part of the legacy (``Compat32``) email API. In the
1212
new API the functionality is provided by the *cte* parameter of
1313
the :meth:`~email.message.EmailMessage.set_content` method.
1414

15+
This module is deprecated in Python 3. The functions provided here
16+
should not be called explicitly since the :class:`~email.mime.text.MIMEText`
17+
class sets the content type and CTE header using the *_subtype* and *_charset*
18+
values passed during the instaniation of that class.
19+
1520
The remaining text in this section is the original documentation of the module.
1621

1722
When creating :class:`~email.message.Message` objects from scratch, you often

0 commit comments

Comments
 (0)