summaryrefslogtreecommitdiffstats
path: root/Lib/email/Message.py
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2003-04-18 23:04:35 (GMT)
committerBarry Warsaw <barry@python.org>2003-04-18 23:04:35 (GMT)
commit482c5f7eb7eb5408dd48359571b12543732604dc (patch)
treea4197cd34ed3d1e2fd3372d1c44ad6ce8ad337f8 /Lib/email/Message.py
parentb05df5796a5a9b5962692a57775308f757b752b6 (diff)
downloadcpython-482c5f7eb7eb5408dd48359571b12543732604dc.zip
cpython-482c5f7eb7eb5408dd48359571b12543732604dc.tar.gz
cpython-482c5f7eb7eb5408dd48359571b12543732604dc.tar.bz2
as_string(): Added some text to the docstring to make it clear that
it's a convenience only and give hints on what to do for more flexibility.
Diffstat (limited to 'Lib/email/Message.py')
-rw-r--r--Lib/email/Message.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/Lib/email/Message.py b/Lib/email/Message.py
index 66f8640..0f513f5 100644
--- a/Lib/email/Message.py
+++ b/Lib/email/Message.py
@@ -102,6 +102,10 @@ class Message:
"""Return the entire formatted message as a string.
Optional `unixfrom' when True, means include the Unix From_ envelope
header.
+
+ This is a convenience method and may not generate the message exactly
+ as you intend. For more flexibility, use the flatten() method of a
+ Generator instance.
"""
from email.Generator import Generator
fp = StringIO()