summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2003-03-11 04:40:14 (GMT)
committerBarry Warsaw <barry@python.org>2003-03-11 04:40:14 (GMT)
commit52b39f5b47202a0c55511bb527b3e1a8140ab43f (patch)
tree3d10384aec61bfe22930f474c507e8569027bdb2 /Doc
parent08898499b27c899872f7ad0c6f82ac20538ba1c6 (diff)
downloadcpython-52b39f5b47202a0c55511bb527b3e1a8140ab43f.zip
cpython-52b39f5b47202a0c55511bb527b3e1a8140ab43f.tar.gz
cpython-52b39f5b47202a0c55511bb527b3e1a8140ab43f.tar.bz2
body_line_iterator() now takes a decode argument.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/emailiter.tex4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/lib/emailiter.tex b/Doc/lib/emailiter.tex
index 9180ac2..d1a8f98 100644
--- a/Doc/lib/emailiter.tex
+++ b/Doc/lib/emailiter.tex
@@ -6,13 +6,15 @@ Iterating over a message object tree is fairly easy with the
provides some useful higher level iterations over message object
trees.
-\begin{funcdesc}{body_line_iterator}{msg}
+\begin{funcdesc}{body_line_iterator}{msg\optional{, decode}}
This iterates over all the payloads in all the subparts of \var{msg},
returning the string payloads line-by-line. It skips over all the
subpart headers, and it skips over any subpart with a payload that
isn't a Python string. This is somewhat equivalent to reading the
flat text representation of the message from a file using
\method{readline()}, skipping over all the intervening headers.
+
+Optional \var{decode} is passed through to \method{Message.get_payload()}.
\end{funcdesc}
\begin{funcdesc}{typed_subpart_iterator}{msg\optional{,