1 | % 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 |
|
---|
8 | \documentclass{howto}
|
---|
9 |
|
---|
10 | \title{email Package Reference}
|
---|
11 | \author{Barry Warsaw}
|
---|
12 | \authoraddress{\email{barry@python.org}}
|
---|
13 |
|
---|
14 | \date{\today}
|
---|
15 | \release{4.0} % software release, not documentation
|
---|
16 | \setreleaseinfo{} % empty for final release
|
---|
17 | \setshortversion{4.0} % major.minor only for software
|
---|
18 |
|
---|
19 | \begin{document}
|
---|
20 |
|
---|
21 | \maketitle
|
---|
22 |
|
---|
23 | \begin{abstract}
|
---|
24 | 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.
|
---|
27 | \end{abstract}
|
---|
28 |
|
---|
29 | % The ugly "%begin{latexonly}" pseudo-environment suppresses the table
|
---|
30 | % of contents for HTML generation.
|
---|
31 | %
|
---|
32 | %begin{latexonly}
|
---|
33 | \tableofcontents
|
---|
34 | %end{latexonly}
|
---|
35 |
|
---|
36 | \section{Introduction}
|
---|
37 | The \module{email} package provides classes and utilities to create,
|
---|
38 | parse, generate, and modify email messages, conforming to all the
|
---|
39 | relevant email and MIME related RFCs.
|
---|
40 |
|
---|
41 | This document describes version 4.0 of the \module{email} package, which is
|
---|
42 | distributed with Python 2.5 and is available as a standalone distutils-based
|
---|
43 | package for use with earlier Python versions. \module{email} 4.0 is not
|
---|
44 | compatible with Python versions earlier than 2.3. For more information about
|
---|
45 | the \module{email} package, including download links and mailing lists, see
|
---|
46 | \ulink{Python's email SIG}{http://www.python.org/sigs/email-sig}.
|
---|
47 |
|
---|
48 | The documentation that follows was written for the Python project, so
|
---|
49 | if you're reading this as part of the standalone \module{email}
|
---|
50 | package 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
|
---|
54 | Python version a feature was added or deprecated. See
|
---|
55 | the package history in section \ref{email-pkg-history} for details.
|
---|
56 |
|
---|
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 |
|
---|
63 | \input{email}
|
---|
64 |
|
---|
65 | \end{document}
|
---|