diff options
| author | R. David Murray <rdmurray@bitdance.com> | 2010-01-10 17:41:28 (GMT) |
|---|---|---|
| committer | R. David Murray <rdmurray@bitdance.com> | 2010-01-10 17:41:28 (GMT) |
| commit | 0e207dff31f1cd4fa65e56d095bcf25c5ee1685f (patch) | |
| tree | bb5f5320fa0022ed296bcf25f28686848f85ad3d | |
| parent | 2e3da14d8b6fc13f1514dce8420c992d7aaf13f8 (diff) | |
| download | cpython-0e207dff31f1cd4fa65e56d095bcf25c5ee1685f.zip cpython-0e207dff31f1cd4fa65e56d095bcf25c5ee1685f.tar.gz cpython-0e207dff31f1cd4fa65e56d095bcf25c5ee1685f.tar.bz2 | |
Issue #7119: document that a program-generated Message object
tree may be mutated when serialized.
| -rw-r--r-- | Doc/library/email.generator.rst | 5 | ||||
| -rw-r--r-- | Doc/library/email.message.rst | 5 | ||||
| -rw-r--r-- | Doc/library/email.mime.rst | 3 |
3 files changed, 10 insertions, 3 deletions
diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst index 8ba426a..f02e7d8 100644 --- a/Doc/library/email.generator.rst +++ b/Doc/library/email.generator.rst @@ -17,7 +17,10 @@ yourself. However the bundled generator knows how to generate most email in a standards-compliant way, should handle MIME and non-MIME email messages just fine, and is designed so that the transformation from flat text, to a message structure via the :class:`~email.parser.Parser` class, and back to flat text, -is idempotent (the input is identical to the output). +is idempotent (the input is identical to the output). On the other hand, using +the Generator on a :class:`~email.message.Message` constructed by program may +result in changes to the :class:`~email.message.Message` object as defaults are +filled in. Here are the public methods of the :class:`Generator` class, imported from the :mod:`email.generator` module: diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index 0e79b6c..85a5d83 100644 --- a/Doc/library/email.message.rst +++ b/Doc/library/email.message.rst @@ -40,7 +40,10 @@ Here are the methods of the :class:`Message` class: Return the entire message flattened as a string. When optional *unixfrom* is ``True``, the envelope header is included in the returned string. - *unixfrom* defaults to ``False``. + *unixfrom* defaults to ``False``. Flattening the message may trigger + changes to the :class:`Message` if defaults need to be filled in to + complete the transformation to a string (for example, MIME boundaries may + be generated or modified). Note that this method is provided as a convenience and may not always format the message the way you want. For example, by default it mangles diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst index 94df8f0..10f3e37 100644 --- a/Doc/library/email.mime.rst +++ b/Doc/library/email.mime.rst @@ -71,7 +71,8 @@ Here are the classes: also be added. Optional *boundary* is the multipart boundary string. When ``None`` (the - default), the boundary is calculated when needed. + default), the boundary is calculated when needed (for example, when the + message is serialized). *_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 |