Document the "unixfrom" attribute of the rfc822.Message class.
authorFred Drake <fdrake@acm.org>
Thu, 6 Sep 2001 15:07:55 +0000 (15:07 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 6 Sep 2001 15:07:55 +0000 (15:07 +0000)
Based on a patch by Skip Montanaro, this closes SF bug #458885.

Doc/lib/librfc822.tex

index 2b5faffb07b1b7be7bececfa589520579e402576..74147154a02f8d2ef7dc23c0947815b7257703d6 100644 (file)
@@ -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}}