summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1997-06-02 17:30:03 (GMT)
committerGuido van Rossum <guido@python.org>1997-06-02 17:30:03 (GMT)
commit067a2acdf69d11893e0164ebeac8436c67464b2a (patch)
tree60a8d6f22dc17380205ecf780c75cd3e50adf246
parentbac80022e461247de1294cc37168c2a600511461 (diff)
downloadcpython-067a2acdf69d11893e0164ebeac8436c67464b2a.zip
cpython-067a2acdf69d11893e0164ebeac8436c67464b2a.tar.gz
cpython-067a2acdf69d11893e0164ebeac8436c67464b2a.tar.bz2
Mention seekable parameter (AMK).
Added pointer to mailbox module.
-rw-r--r--Doc/lib/librfc822.tex9
-rw-r--r--Doc/librfc822.tex9
2 files changed, 14 insertions, 4 deletions
diff --git a/Doc/lib/librfc822.tex b/Doc/lib/librfc822.tex
index 9b2094f..3617e8a 100644
--- a/Doc/lib/librfc822.tex
+++ b/Doc/lib/librfc822.tex
@@ -8,9 +8,14 @@ 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.
+(Note that there's a separate, currently undocumented, module to read
+Unix style mailbox files: \code{mailbox}.)
+
A \code{Message} instance is instantiated with an open file object as
-parameter. Instantiation reads headers from the file up to a blank
-line and stores them in the instance; after instantiation, the file is
+parameter. The optional \code{seekable} parameter indicates if the
+file object is seekable; the default value is 1 for true.
+Instantiation reads headers from the file up to a blank line and
+stores them in the instance; after instantiation, the file is
positioned directly after the blank line that terminates the headers.
Input lines as read from the file may either be terminated by CR-LF or
diff --git a/Doc/librfc822.tex b/Doc/librfc822.tex
index 9b2094f..3617e8a 100644
--- a/Doc/librfc822.tex
+++ b/Doc/librfc822.tex
@@ -8,9 +8,14 @@ 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.
+(Note that there's a separate, currently undocumented, module to read
+Unix style mailbox files: \code{mailbox}.)
+
A \code{Message} instance is instantiated with an open file object as
-parameter. Instantiation reads headers from the file up to a blank
-line and stores them in the instance; after instantiation, the file is
+parameter. The optional \code{seekable} parameter indicates if the
+file object is seekable; the default value is 1 for true.
+Instantiation reads headers from the file up to a blank line and
+stores them in the instance; after instantiation, the file is
positioned directly after the blank line that terminates the headers.
Input lines as read from the file may either be terminated by CR-LF or