summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-09-06 15:07:55 (GMT)
committerFred Drake <fdrake@acm.org>2001-09-06 15:07:55 (GMT)
commitf5072b931482b241bbb9d217a88568189bf17d2b (patch)
treeb2fcf26f73497b29fdcb59dc90b428830afc32b9
parentccc7562315184669791c49b728580773f04f01fb (diff)
downloadcpython-f5072b931482b241bbb9d217a88568189bf17d2b.zip
cpython-f5072b931482b241bbb9d217a88568189bf17d2b.tar.gz
cpython-f5072b931482b241bbb9d217a88568189bf17d2b.tar.bz2
Document the "unixfrom" attribute of the rfc822.Message class.
Based on a patch by Skip Montanaro, this closes SF bug #458885.
-rw-r--r--Doc/lib/librfc822.tex8
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex
index 2b5faff..7414715 100644
--- a/Doc/lib/librfc822.tex
+++ b/Doc/lib/librfc822.tex
@@ -261,7 +261,7 @@ support the \method{clear()}, \method{copy()}, \method{popitem()}, or
\method{get()} and \method{setdefault()} was only added in Python
2.2.)
-Finally, \class{Message} instances have two public instance variables:
+Finally, \class{Message} instances have some public instance variables:
\begin{memberdesc}{headers}
A list containing the entire set of header lines, in the order in
@@ -275,6 +275,12 @@ The file or file-like object passed at instantiation time. This can
be used to read the message content.
\end{memberdesc}
+\begin{memberdesc}{unixfrom}
+The \UNIX{} \samp{From~} line, if the message had one, or an empty
+string. This is needed to regenerate the message in some contexts,
+such as an \code{mbox}-style mailbox file.
+\end{memberdesc}
+
\subsection{AddressList Objects \label{addresslist-objects}}