]> granicus.if.org Git - python/commitdiff
Mention seekable parameter (AMK).
authorGuido van Rossum <guido@python.org>
Mon, 2 Jun 1997 17:30:03 +0000 (17:30 +0000)
committerGuido van Rossum <guido@python.org>
Mon, 2 Jun 1997 17:30:03 +0000 (17:30 +0000)
Added pointer to mailbox module.

Doc/lib/librfc822.tex
Doc/librfc822.tex

index 9b2094feb9ffa8e81b3d33124314f2ea54f27e46..3617e8aa655801591c1772cee90e6ceb386334cb 100644 (file)
@@ -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
index 9b2094feb9ffa8e81b3d33124314f2ea54f27e46..3617e8aa655801591c1772cee90e6ceb386334cb 100644 (file)
@@ -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