[Python-checkins] CVS: python/dist/src/Doc/lib email.tex,1.1,1.2
Fred L. Drake
fdrake@users.sourceforge.net
Wed, 26 Sep 2001 09:52:20 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv27613
Modified Files:
email.tex
Log Message:
Start making some markup adjustments; Barry has indicated he will work on
this before we finish the integration, along with some restructuring.
Index: email.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/email.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** email.tex 2001/09/26 05:23:47 1.1
--- email.tex 2001/09/26 16:52:18 1.2
***************
*** 2,6 ****
% Author: barry@zope.com (Barry Warsaw)
! \section{\module{email} --
An email and MIME handling package}
--- 2,6 ----
% Author: barry@zope.com (Barry Warsaw)
! \section{\module{email} ---
An email and MIME handling package}
***************
*** 65,72 ****
matched case-insensitively. There may also be a single
\emph{Unix-From} header, also known as the envelope header or the
! \code{From_} header. The payload is either a string in the case of
simple message objects, a list of \class{Message} objects for
multipart MIME documents, or a single \class{Message} instance for
! \code{message/rfc822} type objects.
\class{Message} objects provide a mapping style interface for
--- 65,72 ----
matched case-insensitively. There may also be a single
\emph{Unix-From} header, also known as the envelope header or the
! \mailheader{From_} header. The payload is either a string in the case of
simple message objects, a list of \class{Message} objects for
multipart MIME documents, or a single \class{Message} instance for
! \mimetype{message/rfc822} type objects.
\class{Message} objects provide a mapping style interface for
***************
*** 163,169 ****
\method{Message.add_header()}.
! The \class{MIMEBase} class always adds a \code{Content-Type:} header
(based on \var{_maintype}, \var{_subtype}, and \var{_params}), and a
! \code{MIME-Version:} header (always set to \code{1.0}).
\end{classdesc}
--- 163,169 ----
\method{Message.add_header()}.
! The \class{MIMEBase} class always adds a \mailheader{Content-Type} header
(based on \var{_maintype}, \var{_subtype}, and \var{_params}), and a
! \mailheader{MIME-Version} header (always set to \code{1.0}).
\end{classdesc}
***************
*** 172,182 ****
A subclass of \class{MIMEBase}, the \class{MIMEImage} class is used to
! create MIME message objects of major type \code{image}.
\var{_imagedata} is a string containing the raw image data. If this
data can be decoded by the standard Python module \refmodule{imghdr},
then the subtype will be automatically included in the
! \code{Content-Type:} header. Otherwise you can explicitly specify the
image subtype via the \var{_subtype} parameter. If the minor type could
! not be guessed and \var{_subtype} was not given, then \code{TypeError}
is raised.
--- 172,182 ----
A subclass of \class{MIMEBase}, the \class{MIMEImage} class is used to
! create MIME message objects of major type \mimetype{image}.
\var{_imagedata} is a string containing the raw image data. If this
data can be decoded by the standard Python module \refmodule{imghdr},
then the subtype will be automatically included in the
! \mailheader{Content-Type} header. Otherwise you can explicitly specify the
image subtype via the \var{_subtype} parameter. If the minor type could
! not be guessed and \var{_subtype} was not given, then \exception{TypeError}
is raised.
***************
*** 186,190 ****
It should use \method{get_payload()} and \method{set_payload()} to
change the payload to encoded form. It should also add any
! \code{Content-Transfer-Encoding:} or other headers to the message
object as necessary. The default encoding is \emph{Base64}. See the
\refmodule{email.Encoders} module for a list of the built-in encoders.
--- 186,190 ----
It should use \method{get_payload()} and \method{set_payload()} to
change the payload to encoded form. It should also add any
! \mailheader{Content-Transfer-Encoding} or other headers to the message
object as necessary. The default encoding is \emph{Base64}. See the
\refmodule{email.Encoders} module for a list of the built-in encoders.
***************
*** 197,203 ****
_charset\optional{, _encoder}}}}
A subclass of \class{MIMEBase}, the \class{MIMEText} class is used to
! create MIME objects of major type \code{text}. \var{_text} is the string
for the payload. \var{_subtype} is the minor type and defaults to
! \code{plain}. \var{_charset} is the character set of the text and is
passed as a parameter to the \class{MIMEBase} constructor; it defaults
to \code{us-ascii}. No guessing or encoding is performed on the text
--- 197,203 ----
_charset\optional{, _encoder}}}}
A subclass of \class{MIMEBase}, the \class{MIMEText} class is used to
! create MIME objects of major type \mimetype{text}. \var{_text} is the string
for the payload. \var{_subtype} is the minor type and defaults to
! \mimetype{plain}. \var{_charset} is the character set of the text and is
passed as a parameter to the \class{MIMEBase} constructor; it defaults
to \code{us-ascii}. No guessing or encoding is performed on the text
***************
*** 208,212 ****
constructor, except that the default encoding for \class{MIMEText}
objects is one that doesn't actually modify the payload, but does set
! the \code{Content-Transfer-Encoding:} header to \code{7bit} or
\code{8bit} as appropriate.
\end{classdesc}
--- 208,212 ----
constructor, except that the default encoding for \class{MIMEText}
objects is one that doesn't actually modify the payload, but does set
! the \mailheader{Content-Transfer-Encoding} header to \code{7bit} or
\code{8bit} as appropriate.
\end{classdesc}
***************
*** 214,223 ****
\begin{classdesc}{MIMEMessage}{_msg\optional{, _subtype}}
A subclass of \class{MIMEBase}, the \class{MIMEMessage} class is used to
! create MIME objects of main type \code{message}. \var{_msg} is used as
the payload, and must be an instance of class \class{Message} (or a
subclass thereof), otherwise a \exception{TypeError} is raised.
Optional \var{_subtype} sets the subtype of the message; it defaults
! to \code{rfc822}.
\end{classdesc}
--- 214,223 ----
\begin{classdesc}{MIMEMessage}{_msg\optional{, _subtype}}
A subclass of \class{MIMEBase}, the \class{MIMEMessage} class is used to
! create MIME objects of main type \mimetype{message}. \var{_msg} is used as
the payload, and must be an instance of class \class{Message} (or a
subclass thereof), otherwise a \exception{TypeError} is raised.
Optional \var{_subtype} sets the subtype of the message; it defaults
! to \mimetype{rfc822}.
\end{classdesc}
***************
*** 309,313 ****
The \class{Parser} class has no differences in its public interface.
It does have some additional smarts to recognize
! \code{message/delivery-status} type messages, which it represents as
a \class{Message} instance containing separate \class{Message}
subparts for each header block in the delivery status
--- 309,313 ----
The \class{Parser} class has no differences in its public interface.
It does have some additional smarts to recognize
! \mimetype{message/delivery-status} type messages, which it represents as
a \class{Message} instance containing separate \class{Message}
subparts for each header block in the delivery status
***************
*** 340,346 ****
Also, the \class{MIMEMessage} class now represents any kind of
! MIME message with main type \code{message}. It takes an
optional argument \var{_subtype} which is used to set the MIME
! subtype. \var{_subtype} defaults to \code{rfc822}.
\end{itemize}
--- 340,346 ----
Also, the \class{MIMEMessage} class now represents any kind of
! MIME message with main type \mimetype{message}. It takes an
optional argument \var{_subtype} which is used to set the MIME
! subtype. \var{_subtype} defaults to \mimetype{rfc822}.
\end{itemize}