summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.mime.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2013-08-19 06:59:18 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2013-08-19 06:59:18 (GMT)
commite0f0cf406757cea35db0aeaad592c2418d521b45 (patch)
treef2b28faff6f7e583abc5251ddb19aa1c05da280e /Doc/library/email.mime.rst
parentca64d25dd285a784186bc16b3ee39ff8680cabdf (diff)
downloadcpython-e0f0cf406757cea35db0aeaad592c2418d521b45.zip
cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.gz
cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.bz2
Issue #18761: Improved cross-references in email documentation.
Diffstat (limited to 'Doc/library/email.mime.rst')
-rw-r--r--Doc/library/email.mime.rst29
1 files changed, 19 insertions, 10 deletions
diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst
index 192e353..4cdb322 100644
--- a/Doc/library/email.mime.rst
+++ b/Doc/library/email.mime.rst
@@ -35,7 +35,8 @@ Here are the classes:
*_maintype* is the :mailheader:`Content-Type` major type (e.g. :mimetype:`text`
or :mimetype:`image`), and *_subtype* is the :mailheader:`Content-Type` minor
type (e.g. :mimetype:`plain` or :mimetype:`gif`). *_params* is a parameter
- key/value dictionary and is passed directly to :meth:`Message.add_header`.
+ key/value dictionary and is passed directly to :meth:`Message.add_header
+ <email.message.Message.add_header>`.
The :class:`MIMEBase` class always adds a :mailheader:`Content-Type` header
(based on *_maintype*, *_subtype*, and *_params*), and a
@@ -50,8 +51,9 @@ Here are the classes:
A subclass of :class:`~email.mime.base.MIMEBase`, this is an intermediate base
class for MIME messages that are not :mimetype:`multipart`. The primary
- purpose of this class is to prevent the use of the :meth:`attach` method,
- which only makes sense for :mimetype:`multipart` messages. If :meth:`attach`
+ purpose of this class is to prevent the use of the
+ :meth:`~email.message.Message.attach` method, which only makes sense for
+ :mimetype:`multipart` messages. If :meth:`~email.message.Message.attach`
is called, a :exc:`~email.errors.MultipartConversionError` exception is raised.
@@ -74,7 +76,8 @@ Here are the classes:
*_subparts* is a sequence of initial subparts for the payload. It must be
possible to convert this sequence to a list. You can always attach new subparts
- to the message by using the :meth:`Message.attach` method.
+ to the message by using the :meth:`Message.attach
+ <email.message.Message.attach>` method.
Additional parameters for the :mailheader:`Content-Type` header are taken from
the keyword arguments, or passed into the *_params* argument, which is a keyword
@@ -95,8 +98,10 @@ Here are the classes:
Optional *_encoder* is a callable (i.e. function) which will perform the actual
encoding of the data for transport. This callable takes one argument, which is
- the :class:`MIMEApplication` instance. It should use :meth:`get_payload` and
- :meth:`set_payload` to change the payload to encoded form. It should also add
+ the :class:`MIMEApplication` instance. It should use
+ :meth:`~email.message.Message.get_payload` and
+ :meth:`~email.message.Message.set_payload` to change the payload to encoded
+ form. It should also add
any :mailheader:`Content-Transfer-Encoding` or other headers to the message
object as necessary. The default encoding is base64. See the
:mod:`email.encoders` module for a list of the built-in encoders.
@@ -121,8 +126,10 @@ Here are the classes:
Optional *_encoder* is a callable (i.e. function) which will perform the actual
encoding of the audio data for transport. This callable takes one argument,
- which is the :class:`MIMEAudio` instance. It should use :meth:`get_payload` and
- :meth:`set_payload` to change the payload to encoded form. It should also add
+ which is the :class:`MIMEAudio` instance. It should use
+ :meth:`~email.message.Message.get_payload` and
+ :meth:`~email.message.Message.set_payload` to change the payload to encoded
+ form. It should also add
any :mailheader:`Content-Transfer-Encoding` or other headers to the message
object as necessary. The default encoding is base64. See the
:mod:`email.encoders` module for a list of the built-in encoders.
@@ -147,8 +154,10 @@ Here are the classes:
Optional *_encoder* is a callable (i.e. function) which will perform the actual
encoding of the image data for transport. This callable takes one argument,
- which is the :class:`MIMEImage` instance. It should use :meth:`get_payload` and
- :meth:`set_payload` to change the payload to encoded form. It should also add
+ which is the :class:`MIMEImage` instance. It should use
+ :meth:`~email.message.Message.get_payload` and
+ :meth:`~email.message.Message.set_payload` to change the payload to encoded
+ form. It should also add
any :mailheader:`Content-Transfer-Encoding` or other headers to the message
object as necessary. The default encoding is base64. See the
:mod:`email.encoders` module for a list of the built-in encoders.