[Python-checkins] CVS: python/dist/src/Doc/lib emailparser.tex,1.2,1.3

[Barry Warsaw]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv28614

Modified Files:
	emailparser.tex 
Log Message:
Describe the HeaderParser class.


Index: emailparser.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/emailparser.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** emailparser.tex	2001/09/26 22:21:52	1.2
--- emailparser.tex	2001/10/11 15:45:05	1.3
***************
*** 25,28 ****
--- 25,39 ----
  message object trees in any way it find necessary.
  
+ The primary parser class is \class{Parser} which parses both the
+ headers and the payload of the message.  In the case of
+ \mimetype{multipart} messages, it will recursively parse the body of
+ the container message.  The \module{email.Parser} module also provides
+ a second class, called \class{HeaderParser} which can be used if
+ you're only interested in the headers of the message.
+ \class{HeaderParser} can be much faster in this situations, since it
+ does not attempt to parse the message body, instead setting the
+ payload to the raw body as a string.  \class{HeaderParser} has the
+ same API as the \class{Parser} class.
+ 
  \subsubsection{Parser class API}