summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-03-15 18:01:18 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-03-15 18:01:18 (GMT)
commit7dedcb46441803444a3bdb0f9773d9d9b10186e9 (patch)
treefe1ad163264f4888598458d496850be2c7ff7a77 /Doc
parent8beaa6c2eca32351a6bc3204f4350176fd972fd6 (diff)
downloadcpython-7dedcb46441803444a3bdb0f9773d9d9b10186e9.zip
cpython-7dedcb46441803444a3bdb0f9773d9d9b10186e9.tar.gz
cpython-7dedcb46441803444a3bdb0f9773d9d9b10186e9.tar.bz2
#11555: update doc for 3.x change to as_string mangle_from default.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/email.message.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst
index f261b9c..d1a12c5 100644
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -46,15 +46,16 @@ Here are the methods of the :class:`Message` class:
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
- lines that begin with ``From``. For more flexibility, instantiate a
+ format the message the way you want. For example, by default it does
+ not do the mangling of lines that begin with ``From`` that is
+ required by the unix mbox format. For more flexibility, instantiate a
:class:`~email.generator.Generator` instance and use its :meth:`flatten`
method directly. For example::
from io import StringIO
from email.generator import Generator
fp = StringIO()
- g = Generator(fp, mangle_from_=False, maxheaderlen=60)
+ g = Generator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()