Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit de6977f

Browse files
committed
Added an introduction.
1 parent c616173 commit de6977f

1 file changed

Lines changed: 57 additions & 1 deletion

File tree

Doc/lib/mimelib.tex

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
\maketitle
1515

1616
\begin{abstract}
17-
The \module{email} package can be used to handle email.
17+
The \module{email} package provides classes and utilities to create,
18+
parse, generate, and modify email messages, conforming to all the
19+
relevant email and MIME related RFCs.
1820
\end{abstract}
1921

2022
% The ugly "%begin{latexonly}" pseudo-environment supresses the table
@@ -24,6 +26,60 @@
2426
\tableofcontents
2527
%end{latexonly}
2628

29+
\section{Introduction}
30+
The \module{email} package provides classes and utilities to create,
31+
parse, generate, and modify email messages, conforming to all the
32+
relevant email and MIME related RFCs.
33+
34+
This document describes the current version of the \module{email}
35+
package, which is available to Python programmers in a number of ways.
36+
Python 2.2.2 and 2.3 come with \module{email} version 2, while earlier
37+
versions of Python 2.2.x come with \module{email} version 1. Python
38+
2.1.x and earlier do not come with any version of the \module{email}
39+
package.
40+
41+
The \module{email} package is also available as a standalone distutils
42+
package, and is compatible with Python 2.1.3 and beyond. Thus, if
43+
you're using Python 2.1.3 you can download the standalone package and
44+
install it in your \file{site-packages} directory. The standalone
45+
\module{email} package is available on the
46+
\ulink{SourceForge \module{mimelib} project}{http://mimelib.sf.net}.
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. To find out
55+
what version of the \module{email} package a particular item was
56+
added, changed, or removed, refer to the package's
57+
\ulink{\file{NEWS} file}{http://cvs.sf.net/cgi-bin/viewcvs.cgi/mimelib/mimelib/NEWS?rev=1.36&content-type=text/vnd.viewcvs-markup}.
58+
59+
\item The code samples are written with Python 2.2 in mind. For
60+
Python 2.1.3, some adjustments are necessary. For example, this
61+
code snippet;
62+
63+
\begin{verbatim}
64+
if isinstance(s, str):
65+
# ...
66+
\end{verbatim}
67+
68+
would need to be written this way in Python 2.1.3:
69+
70+
\begin{verbatim}
71+
from types import StringType
72+
# ...
73+
if isinstance(s, StringType):
74+
# ...
75+
\end{verbatim}
76+
77+
\item If you're reading this documentation as part of the
78+
standalone \module{email} package, some of the internal links to
79+
other sections of the Python standard library may not resolve.
80+
81+
\end{itemize}
82+
2783
\input{email}
2884

2985
\end{document}

0 commit comments

Comments
 (0)