Document the "unixfrom" attribute of the rfc822.Message class.

freddrake · freddrake · commit f5072b931482 · 2001-09-06T15:07:55.000Z
Based on a patch by Skip Montanaro, this closes SF bug #458885.
diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex
@@ -261,7 +261,7 @@ \subsection{Message Objects \label{message-objects}}
 \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 @@ \subsection{Message Objects \label{message-objects}}
 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}}
 
