diff options
| author | R David Murray <rdmurray@bitdance.com> | 2012-09-28 15:21:32 -0400 |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2012-09-28 15:21:32 -0400 |
| commit | 9faaf1b43efede5110d8dc7c78a53adb08396be3 (patch) | |
| tree | 57c5626412bba87463b585b2d573d5828df222fd | |
| parent | 9662b849135b8812a03536f2c6ea0021fb504a26 (diff) | |
| download | cpython-git-9faaf1b43efede5110d8dc7c78a53adb08396be3.tar.gz | |
#16071: fix email.message links in the mailbox docs.
| -rw-r--r-- | Doc/library/mailbox.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst index a5d2aa0f51..3a87c13ff8 100644 --- a/Doc/library/mailbox.rst +++ b/Doc/library/mailbox.rst @@ -11,8 +11,9 @@ This module defines two classes, :class:`Mailbox` and :class:`Message`, for accessing and manipulating on-disk mailboxes and the messages they contain. :class:`Mailbox` offers a dictionary-like mapping from keys to messages. -:class:`Message` extends the :mod:`email.Message` module's :class:`Message` -class with format-specific state and behavior. Supported mailbox formats are +:class:`Message` extends the :mod:`email.message` module's +:class:`~email.message.Message` class with format-specific state and behavior. +Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. @@ -83,7 +84,7 @@ Maildir, mbox, MH, Babyl, and MMDF. it. 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 appropriate format-specific :class:`Message` subclass (e.g., if it's an :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*. 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 instance of the appropriate format-specific :class:`Message` subclass (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]) - A subclass of the :mod:`email.Message` module's :class:`Message`. Subclasses of - :class:`mailbox.Message` add mailbox-format-specific state and behavior. + A subclass of the :mod:`email.message` module's + :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 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 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 @@ -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 *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). |