From fbcde75c706b7de0e7455612dc15cc1d47763242 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Wed, 11 Sep 2002 14:11:35 +0000 Subject: get_payload(): Document that calling it with no arguments returns a reference to the payload. --- Lib/email/Message.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Lib/email/Message.py b/Lib/email/Message.py index 326d0b8..c018ae7 100644 --- a/Lib/email/Message.py +++ b/Lib/email/Message.py @@ -150,8 +150,10 @@ class Message: self._payload.append(payload) def get_payload(self, i=None, decode=0): - """Return the current payload exactly as is. + """Return a reference to the payload. + The payload is typically either a list object or a string. If you + mutate the list object, you modify the message's payload in place. Optional i returns that index into the payload. Optional decode is a flag indicating whether the payload should be @@ -180,7 +182,6 @@ class Message: # unchanged. return payload - def set_payload(self, payload, charset=None): """Set the payload to the given value. -- cgit v0.12