blob: 491d844eb6bf5a60687cd2a5f39480607951dfe0 [file] [log] [blame]
Fred Drake0ba55412002-10-01 18:20:16 +00001% This document is largely a stub used to allow the email package docs
2% to be formatted separately from the rest of the Python
3% documentation. This allows the documentation to be released
4% independently of the rest of Python since the email package is being
5% maintained for multiple Python versions, and on an accelerated
6% schedule.
7
Fred Drakec6161732002-10-01 14:38:47 +00008\documentclass{howto}
9
10\title{email Package Reference}
11\author{Barry Warsaw}
Barry Warsaw43790b42004-10-03 03:57:37 +000012\authoraddress{\email{barry@python.org}}
Fred Drakec6161732002-10-01 14:38:47 +000013
14\date{\today}
Barry Warsaw40ef0062006-03-18 15:41:53 +000015\release{4.0} % software release, not documentation
Fred Drakec6161732002-10-01 14:38:47 +000016\setreleaseinfo{} % empty for final release
Barry Warsaw40ef0062006-03-18 15:41:53 +000017\setshortversion{4.0} % major.minor only for software
Fred Drakec6161732002-10-01 14:38:47 +000018
19\begin{document}
20
21\maketitle
22
23\begin{abstract}
Barry Warsawde6977f2002-10-01 15:13:29 +000024 The \module{email} package provides classes and utilities to create,
25 parse, generate, and modify email messages, conforming to all the
26 relevant email and MIME related RFCs.
Fred Drakec6161732002-10-01 14:38:47 +000027\end{abstract}
28
Raymond Hettinger68804312005-01-01 00:28:46 +000029% The ugly "%begin{latexonly}" pseudo-environment suppresses the table
Fred Drakec6161732002-10-01 14:38:47 +000030% of contents for HTML generation.
31%
32%begin{latexonly}
33\tableofcontents
34%end{latexonly}
35
Barry Warsawde6977f2002-10-01 15:13:29 +000036\section{Introduction}
37The \module{email} package provides classes and utilities to create,
38parse, generate, and modify email messages, conforming to all the
39relevant email and MIME related RFCs.
40
Barry Warsaw40ef0062006-03-18 15:41:53 +000041This document describes version 4.0 of the \module{email} package, which is
42distributed with Python 2.5 and is available as a standalone distutils-based
43package for use with earlier Python versions. \module{email} 4.0 is not
44compatible with Python versions earlier than 2.3. For more information about
45the \module{email} package, including download links and mailing lists, see
Barry Warsaw43790b42004-10-03 03:57:37 +000046\ulink{Python's email SIG}{http://www.python.org/sigs/email-sig}.
Barry Warsawde6977f2002-10-01 15:13:29 +000047
48The documentation that follows was written for the Python project, so
49if you're reading this as part of the standalone \module{email}
50package documentation, there are a few notes to be aware of:
51
52\begin{itemize}
53\item Deprecation and ``version added'' notes are relative to the
Barry Warsaw40ef0062006-03-18 15:41:53 +000054 Python version a feature was added or deprecated. See
55 the package history in section \ref{email-pkg-history} for details.
Barry Warsawde6977f2002-10-01 15:13:29 +000056
57\item If you're reading this documentation as part of the
58 standalone \module{email} package, some of the internal links to
59 other sections of the Python standard library may not resolve.
60
61\end{itemize}
62
Fred Drakec6161732002-10-01 14:38:47 +000063\input{email}
64
65\end{document}