]> granicus.if.org Git - python/commitdiff
Merged revisions 77417 via svnmerge from
authorR. David Murray <rdmurray@bitdance.com>
Sun, 10 Jan 2010 19:21:20 +0000 (19:21 +0000)
committerR. David Murray <rdmurray@bitdance.com>
Sun, 10 Jan 2010 19:21:20 +0000 (19:21 +0000)
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r77417 | r.david.murray | 2010-01-10 14:18:27 -0500 (Sun, 10 Jan 2010) | 10 lines

  Merged revisions 77412 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r77412 | r.david.murray | 2010-01-10 12:41:28 -0500 (Sun, 10 Jan 2010) | 3 lines

    Issue #7119: document that a program-generated Message object
    tree may be mutated when serialized.
  ........
................

Doc/library/email.generator.rst
Doc/library/email.message.rst
Doc/library/email.mime.rst

index 2061f7645f20b0d34bbb93c48159e8accfc7f79a..ba38f6851461655db59731e6a74f8e687ac959cb 100644 (file)
@@ -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:
index 93dda698b240c75ea188177126f16e3bebc79f14..7e939c91eb6689d46fd46ecc28cb3281ab5f4180 100644 (file)
@@ -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
index 703110abcefdd08ccb8edae311b45ff73176bad6..9cd94d8926f9d2d861deb891600ac11c8c25574c 100644 (file)
@@ -69,7 +69,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