Commit ea002057 authored by Fred Drake's avatar Fred Drake

Use \rfc to mark some remaining RFC references.

Remove comment about full name bug in getaddrlist(); this has been
fixed for a while now.

Work around LaTeX2HTML space-dropping bug.

Mention that the fp attribute can be used to read the message body.
parent 5712fa92
...@@ -8,7 +8,7 @@ This module defines a class, \class{Message}, which represents a ...@@ -8,7 +8,7 @@ This module defines a class, \class{Message}, which represents a
collection of ``email headers'' as defined by the Internet standard collection of ``email headers'' as defined by the Internet standard
\rfc{822}. It is used in various contexts, usually to read such \rfc{822}. It is used in various contexts, usually to read such
headers from a file. This module also defines a helper class headers from a file. This module also defines a helper class
\class{AddressList} for parsing RFC822 addresses. \class{AddressList} for parsing \rfc{822} addresses.
Note that there's a separate module to read \UNIX{}, MH, and MMDF Note that there's a separate module to read \UNIX{}, MH, and MMDF
style mailbox files: \refmodule{mailbox}\refstmodindex{mailbox}. style mailbox files: \refmodule{mailbox}\refstmodindex{mailbox}.
...@@ -86,8 +86,8 @@ difference; this may yield a slight error around daylight savings time ...@@ -86,8 +86,8 @@ difference; this may yield a slight error around daylight savings time
switch dates. Not enough to worry about for common use. switch dates. Not enough to worry about for common use.
\end{funcdesc} \end{funcdesc}
\subsection{Message Objects}
\label{message-objects} \subsection{Message Objects \label{message-objects}}
A \class{Message} instance has the following methods: A \class{Message} instance has the following methods:
...@@ -98,7 +98,7 @@ object is seekable. ...@@ -98,7 +98,7 @@ object is seekable.
\begin{methoddesc}{isheader}{line} \begin{methoddesc}{isheader}{line}
Returns a line's canonicalized fieldname (the dictionary key that will Returns a line's canonicalized fieldname (the dictionary key that will
be used to index it) if the line is a legal RFC822 header; otherwise be used to index it) if the line is a legal \rfc{822} header; otherwise
returns None (implying that parsing should stop here and the line be returns None (implying that parsing should stop here and the line be
pushed back on the input stream). It is sometimes useful to override pushed back on the input stream). It is sometimes useful to override
this method in a subclass. this method in a subclass.
...@@ -126,8 +126,8 @@ header matches \var{name}. ...@@ -126,8 +126,8 @@ header matches \var{name}.
\begin{methoddesc}{getfirstmatchingheader}{name} \begin{methoddesc}{getfirstmatchingheader}{name}
Return a list of lines comprising the first header matching Return a list of lines comprising the first header matching
\var{name}, and its continuation line(s), if any. Return \code{None} \var{name}, and its continuation line(s), if any. Return
if there is no header matching \var{name}. \code{None} if there is no header matching \var{name}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{getrawheader}{name} \begin{methoddesc}{getrawheader}{name}
...@@ -176,9 +176,6 @@ header matching \var{name}, return an empty list. ...@@ -176,9 +176,6 @@ header matching \var{name}, return an empty list.
If multiple headers exist that match the named header (e.g. if there If multiple headers exist that match the named header (e.g. if there
are several \code{Cc} headers), all are parsed for addresses. Any are several \code{Cc} headers), all are parsed for addresses. Any
continuation lines the named headers contain are also parsed. continuation lines the named headers contain are also parsed.
XXX The current version of this function is not really correct. It
yields bogus results if a full name contains a comma.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{getdate}{name} \begin{methoddesc}{getdate}{name}
...@@ -219,11 +216,12 @@ blank line terminating the headers is not contained in the list. ...@@ -219,11 +216,12 @@ blank line terminating the headers is not contained in the list.
\end{memberdesc} \end{memberdesc}
\begin{memberdesc}{fp} \begin{memberdesc}{fp}
The file object passed at instantiation time. The file or file-like object passed at instantiation time. This can
be used to read the message content.
\end{memberdesc} \end{memberdesc}
\subsection{AddressList Objects}
\label{addresslist-objects} \subsection{AddressList Objects \label{addresslist-objects}}
An \class{AddressList} instance has the following methods: An \class{AddressList} instance has the following methods:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment