Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

#16071: fix email.message links in the mailbox docs.

This commit is contained in:
R David Murray 2012-09-28 15:21:32 -04:00
parent 9662b84913
commit 9faaf1b43e
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/mailbox.rst
View File

@ -11,8 +11,9 @@
This module defines two classes, :class:`Mailbox` and :class:`Message`, for This module defines two classes, :class:`Mailbox` and :class:`Message`, for
accessing and manipulating on-disk mailboxes and the messages they contain. accessing and manipulating on-disk mailboxes and the messages they contain.
:class:`Mailbox` offers a dictionary-like mapping from keys to messages. :class:`Mailbox` offers a dictionary-like mapping from keys to messages.
:class:`Message` extends the :mod:`email.Message` module's :class:`Message` :class:`Message` extends the :mod:`email.message` module's
class with format-specific state and behavior. Supported mailbox formats are :class:`~email.message.Message` class with format-specific state and behavior.
Supported mailbox formats are
Maildir, mbox, MH, Babyl, and MMDF. Maildir, mbox, MH, Babyl, and MMDF.
@ -83,7 +84,7 @@ Maildir, mbox, MH, Babyl, and MMDF.
it. it.
Parameter *message* may be a :class:`Message` instance, an Parameter *message* may be a :class:`Message` instance, an
:class:`email.Message.Message` instance, a string, or a file-like object :class:`email.message.Message` instance, a string, or a file-like object
(which should be open in text mode). If *message* is an instance of the (which should be open in text mode). If *message* is an instance of the
appropriate format-specific :class:`Message` subclass (e.g., if it's an appropriate format-specific :class:`Message` subclass (e.g., if it's an
:class:`mboxMessage` instance and this is an :class:`mbox` instance), its :class:`mboxMessage` instance and this is an :class:`mbox` instance), its
@ -110,7 +111,7 @@ Maildir, mbox, MH, Babyl, and MMDF.
:exc:`KeyError` exception if no message already corresponds to *key*. :exc:`KeyError` exception if no message already corresponds to *key*.
As with :meth:`add`, parameter *message* may be a :class:`Message` As with :meth:`add`, parameter *message* may be a :class:`Message`
instance, an :class:`email.Message.Message` instance, a string, or a instance, an :class:`email.message.Message` instance, a string, or a
file-like object (which should be open in text mode). If *message* is an file-like object (which should be open in text mode). If *message* is an
instance of the appropriate format-specific :class:`Message` subclass instance of the appropriate format-specific :class:`Message` subclass
(e.g., if it's an :class:`mboxMessage` instance and this is an (e.g., if it's an :class:`mboxMessage` instance and this is an
@ -743,11 +744,12 @@ Maildir, mbox, MH, Babyl, and MMDF.
.. class:: Message([message]) .. class:: Message([message])
A subclass of the :mod:`email.Message` module's :class:`Message`. Subclasses of A subclass of the :mod:`email.message` module's
:class:`mailbox.Message` add mailbox-format-specific state and behavior. :class:`~email.message.Message`. Subclasses of :class:`mailbox.Message` add
mailbox-format-specific state and behavior.
If *message* is omitted, the new instance is created in a default, empty state. If *message* is omitted, the new instance is created in a default, empty state.
If *message* is an :class:`email.Message.Message` instance, its contents are If *message* is an :class:`email.message.Message` instance, its contents are
copied; furthermore, any format-specific information is converted insofar as copied; furthermore, any format-specific information is converted insofar as
possible if *message* is a :class:`Message` instance. If *message* is a string possible if *message* is a :class:`Message` instance. If *message* is a string
or a file, it should contain an :rfc:`2822`\ -compliant message, which is read or a file, it should contain an :rfc:`2822`\ -compliant message, which is read
@ -1251,7 +1253,7 @@ When an :class:`MHMessage` instance is created based upon a
Set the message's visible headers to be the same as the headers in Set the message's visible headers to be the same as the headers in
*message*. Parameter *visible* should be a :class:`Message` instance, an *message*. Parameter *visible* should be a :class:`Message` instance, an
:class:`email.Message.Message` instance, a string, or a file-like object :class:`email.message.Message` instance, a string, or a file-like object
(which should be open in text mode). (which should be open in text mode).