summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.encoders.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-04-27 16:46:17 (GMT)
committerGeorg Brandl <georg@python.org>2009-04-27 16:46:17 (GMT)
commit3638e487b94da01a8e29f376ed5706c5195a7698 (patch)
tree9729bd00d7e02878688d12eb7aa37f21d293e558 /Doc/library/email.encoders.rst
parent540b45c475aef0d2b803c4d4025a469eefeaa975 (diff)
downloadcpython-3638e487b94da01a8e29f376ed5706c5195a7698.zip
cpython-3638e487b94da01a8e29f376ed5706c5195a7698.tar.gz
cpython-3638e487b94da01a8e29f376ed5706c5195a7698.tar.bz2
Merged revisions 71572 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r71572 | georg.brandl | 2009-04-13 15:13:25 +0200 (Mo, 13 Apr 2009) | 1 line #5745: more linking for identifiers in email docs. ........
Diffstat (limited to 'Doc/library/email.encoders.rst')
-rw-r--r--Doc/library/email.encoders.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst
index 28669c4..5421b9f 100644
--- a/Doc/library/email.encoders.rst
+++ b/Doc/library/email.encoders.rst
@@ -5,18 +5,18 @@
:synopsis: Encoders for email message payloads.
-When creating :class:`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 containing
-binary data.
+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
+containing binary data.
The :mod:`email` package provides some convenient encodings in its
:mod:`encoders` module. These encoders are actually used by the
-:class:`MIMEAudio` and :class:`MIMEImage` class constructors to provide default
-encodings. All encoder functions take exactly one argument, the message object
-to encode. They usually extract the payload, encode it, and reset the payload
-to this newly encoded value. They should also set the
-:mailheader:`Content-Transfer-Encoding` header as appropriate.
+:class:`~email.mime.audio.MIMEAudio` and :class:`~email.mime.image.MIMEImage`
+class constructors to provide default encodings. All encoder functions take
+exactly one argument, the message object to encode. They usually extract the
+payload, encode it, and reset the payload to this newly encoded value. They
+should also set the :mailheader:`Content-Transfer-Encoding` header as appropriate.
Here are the encoding functions provided: