From 7dedcb46441803444a3bdb0f9773d9d9b10186e9 Mon Sep 17 00:00:00 2001 From: R David Murray Date: Tue, 15 Mar 2011 14:01:18 -0400 Subject: [PATCH] #11555: update doc for 3.x change to as_string mangle_from default. --- Doc/library/email.message.rst | 7 ++++--- Lib/email/message.py | 3 +-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index f261b9c5852..d1a12c542d9 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() diff --git a/Lib/email/message.py b/Lib/email/message.py index 9ef2363e625..d30f109a5ba 100644 --- a/Lib/email/message.py +++ b/Lib/email/message.py @@ -136,8 +136,7 @@ class Message: header. This is a convenience method and may not generate the message exactly - as you intend because by default it mangles lines that begin with - "From ". For more flexibility, use the flatten() method of a + as you intend. For more flexibility, use the flatten() method of a Generator instance. """ from email.generator import Generator