1 \declaremodule{standard
}{email.Iterators
}
2 \modulesynopsis{Iterate over a message object tree.
}
4 Iterating over a message object tree is fairly easy with the
5 \method{Message.walk()
} method. The
\module{email.Iterators
} module
6 provides some useful higher level iterations over message object
9 \begin{funcdesc
}{body_line_iterator
}{msg
}
10 This iterates over all the payloads in all the subparts of
\var{msg
},
11 returning the string payloads line-by-line. It skips over all the
12 subpart headers, and it skips over any subpart with a payload that
13 isn't a Python string. This is somewhat equivalent to reading the
14 flat text representation of the message from a file using
15 \method{readline()
}, skipping over all the intervening headers.
18 \begin{funcdesc
}{typed_subpart_iterator
}{msg
\optional{,
19 maintype
\optional{, subtype
}}}
20 This iterates over all the subparts of
\var{msg
}, returning only those
21 subparts that match the MIME type specified by
\var{maintype
} and
24 Note that
\var{subtype
} is optional; if omitted, then subpart MIME
25 type matching is done only with the main type.
\var{maintype
} is
26 optional too; it defaults to
\mimetype{text
}.
28 Thus, by default
\function{typed_subpart_iterator()
} returns each
29 subpart that has a MIME type of
\mimetype{text/*
}.
