Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Fred Drake 1999-04-28 18:11:09 +00:00
parent 5712fa9250
commit ea0020571f
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Doc/lib/librfc822.tex
View File

@ -8,7 +8,7 @@ This module defines a class, \class{Message}, which represents a
collection of ``email headers'' as defined by the Internet standard
\rfc{822}. It is used in various contexts, usually to read such
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
style mailbox files: \refmodule{mailbox}\refstmodindex{mailbox}.
@ -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.
\end{funcdesc}
\subsection{Message Objects}
\label{message-objects}
\subsection{Message Objects \label{message-objects}}
A \class{Message} instance has the following methods:
@ -98,7 +98,7 @@ object is seekable.
\begin{methoddesc}{isheader}{line}
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
pushed back on the input stream). It is sometimes useful to override
this method in a subclass.
@ -126,8 +126,8 @@ header matches \var{name}.
\begin{methoddesc}{getfirstmatchingheader}{name}
Return a list of lines comprising the first header matching
\var{name}, and its continuation line(s), if any. Return \code{None}
if there is no header matching \var{name}.
\var{name}, and its continuation line(s), if any. Return
\code{None} if there is no header matching \var{name}.
\end{methoddesc}
\begin{methoddesc}{getrawheader}{name}
@ -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
are several \code{Cc} headers), all are parsed for addresses. Any
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}
\begin{methoddesc}{getdate}{name}
@ -219,11 +216,12 @@ blank line terminating the headers is not contained in the list.
\end{memberdesc}
\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}
\subsection{AddressList Objects}
\label{addresslist-objects}
\subsection{AddressList Objects \label{addresslist-objects}}
An \class{AddressList} instance has the following methods: