[Python-checkins] r42856 - in sandbox/trunk/emailpkg/4_0: docs/email-pkg-history.html docs/index.html docs/mimelib.html docs/mimelib.pdf docs/module-email.encoders.html docs/module-email.errors.html docs/module-email.generator.html docs/module-email.header.html docs/module-email.html docs/module-email.iterators.html docs/module-email.message.html docs/module-email.mime.text.html docs/module-email.parser.html docs/module-email.utils.html docs/node1.html docs/node17.html docs/node18.html docs/node6.html email/__init__.py manual/Makefile manual/email.tex manual/emailmimebase.tex manual/mimelib.tex
barry.warsaw
python-checkins at python.org
Sun Mar 5 21:27:58 CET 2006
Author: barry.warsaw
Date: Sun Mar 5 21:27:55 2006
New Revision: 42856
Added:
sandbox/trunk/emailpkg/4_0/docs/email-pkg-history.html
Modified:
sandbox/trunk/emailpkg/4_0/docs/index.html
sandbox/trunk/emailpkg/4_0/docs/mimelib.html
sandbox/trunk/emailpkg/4_0/docs/mimelib.pdf
sandbox/trunk/emailpkg/4_0/docs/module-email.encoders.html
sandbox/trunk/emailpkg/4_0/docs/module-email.errors.html
sandbox/trunk/emailpkg/4_0/docs/module-email.generator.html
sandbox/trunk/emailpkg/4_0/docs/module-email.header.html
sandbox/trunk/emailpkg/4_0/docs/module-email.html
sandbox/trunk/emailpkg/4_0/docs/module-email.iterators.html
sandbox/trunk/emailpkg/4_0/docs/module-email.message.html
sandbox/trunk/emailpkg/4_0/docs/module-email.mime.text.html
sandbox/trunk/emailpkg/4_0/docs/module-email.parser.html
sandbox/trunk/emailpkg/4_0/docs/module-email.utils.html
sandbox/trunk/emailpkg/4_0/docs/node1.html
sandbox/trunk/emailpkg/4_0/docs/node17.html
sandbox/trunk/emailpkg/4_0/docs/node18.html
sandbox/trunk/emailpkg/4_0/docs/node6.html
sandbox/trunk/emailpkg/4_0/email/__init__.py
sandbox/trunk/emailpkg/4_0/manual/Makefile
sandbox/trunk/emailpkg/4_0/manual/email.tex
sandbox/trunk/emailpkg/4_0/manual/emailmimebase.tex
sandbox/trunk/emailpkg/4_0/manual/mimelib.tex
Log:
Updated documentation. Bump to 4.0a2 and ready for upload and release.
Added: sandbox/trunk/emailpkg/4_0/docs/email-pkg-history.html
==============================================================================
--- (empty file)
+++ sandbox/trunk/emailpkg/4_0/docs/email-pkg-history.html Sun Mar 5 21:27:55 2006
@@ -0,0 +1,294 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<link rel="STYLESHEET" href="mimelib.css" type='text/css' />
+<link rel="first" href="mimelib.html" title='email Package Reference' />
+<link rel='last' href='about.html' title='About this document...' />
+<link rel='help' href='about.html' title='About this document...' />
+<link rel="next" href="node17.html" />
+<link rel="prev" href="module-email.iterators.html" />
+<link rel="parent" href="module-email.html" />
+<link rel="next" href="node17.html" />
+<meta name='aesop' content='information' />
+<title>2.11 Package History</title>
+</head>
+<body>
+<DIV CLASS="navigation">
+<div id='top-navigation-panel' xml:id='top-navigation-panel'>
+<table align="center" width="100%" cellpadding="0" cellspacing="2">
+<tr>
+<td class='online-navigation'><a rel="prev" title="2.10 Iterators"
+ href="module-email.iterators.html"><img src='previous.png'
+ border='0' height='32' alt='Previous Page' width='32' /></A></td>
+<td class='online-navigation'><a rel="parent" title="2 email "
+ href="module-email.html"><img src='up.png'
+ border='0' height='32' alt='Up One Level' width='32' /></A></td>
+<td class='online-navigation'><a rel="next" title="2.12 Differences from mimelib"
+ href="node17.html"><img src='next.png'
+ border='0' height='32' alt='Next Page' width='32' /></A></td>
+<td align="center" width="100%">email Package Reference</td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+</tr></table>
+<div class='online-navigation'>
+<b class="navlabel">Previous:</b>
+<a class="sectref" rel="prev" href="module-email.iterators.html">2.10 Iterators</A>
+<b class="navlabel">Up:</b>
+<a class="sectref" rel="parent" href="module-email.html">2 email </A>
+<b class="navlabel">Next:</b>
+<a class="sectref" rel="next" href="node17.html">2.12 Differences from mimelib</A>
+</div>
+<hr /></div>
+</DIV>
+<!--End of Navigation Panel-->
+
+<H2><A NAME="SECTION0002110000000000000000"></A><A NAME="email-pkg-history"></A>
+<BR>
+2.11 Package History
+</H2>
+
+<P>
+This table describes the release history of the email package, corresponding
+to the version of Python that the package was released with. For purposes of
+this document, when you see a note about change or added versions, these refer
+to the Python version the change was made it, <em>not</em> the email package
+version. This table also describes the Python compatibility of each version
+of the package.
+
+<P>
+<div class="center"><table class="realtable">
+ <thead>
+ <tr>
+ <th class="left" >email version</th>
+ <th class="left" >distributed with</th>
+ <th class="left" >compatible with</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr><td class="left" valign="baseline"><tt class="constant">1.x</tt></td>
+ <td class="left" >Python 2.2.0 to Python 2.2.1</td>
+ <td class="left" ><em>no longer supported</em></td></tr>
+ <tr><td class="left" valign="baseline"><tt class="constant">2.5</tt></td>
+ <td class="left" >Python 2.2.2+ and Python 2.3</td>
+ <td class="left" >Python 2.1 to 2.5</td></tr>
+ <tr><td class="left" valign="baseline"><tt class="constant">3.0</tt></td>
+ <td class="left" >Python 2.4</td>
+ <td class="left" >Python 2.3 to 2.5</td></tr>
+ <tr><td class="left" valign="baseline"><tt class="constant">4.0</tt></td>
+ <td class="left" >Python 2.5</td>
+ <td class="left" >Python 2.3 to 2.5</td></tr></tbody>
+</table></div>
+
+<P>
+Here are the major differences between <tt class="module">email</tt> verson 4 and version 3:
+
+<P>
+
+<UL>
+<LI>All modules have been renamed according to <a class="rfc" id='rfcref-3341' xml:id='rfcref-3341'
+href="http://www.python.org/peps/pep-0008.html">PEP 8</a> standards. For
+ example, the version 3 module <tt class="module">email.Message</tt> was renamed to
+ <tt class="module">email.message</tt> in version 4.
+
+<P>
+</LI>
+<LI>A new subpackage <tt class="module">email.mime</tt> was added and all the version 3
+ <tt class="module">email.MIME*</tt> modules were renamed and situated into the
+ <tt class="module">email.mime</tt> subpackage. For example, the version 3 module
+ <tt class="module">email.MIMEText</tt> was renamed to <tt class="module">email.mime.text</tt>.
+
+<P>
+<em>Note that the version 3 names will continue to work until Python
+ 2.6</em>.
+
+<P>
+</LI>
+<LI>The <tt class="module">email.mime.application</tt> module was added, which contains the
+ <tt class="class">MIMEApplication</tt> class.
+
+<P>
+</LI>
+<LI>Methods that were deprecated in version 3 have been removed. These
+ include <tt class="method">Generator.__call__()</tt>, <tt class="method">Message.get_type()</tt>,
+ <tt class="method">Message.get_main_type()</tt>, <tt class="method">Message.get_subtype()</tt>.
+</LI>
+</UL>
+
+<P>
+Here are the major differences between <tt class="module">email</tt> version 3 and version 2:
+
+<P>
+
+<UL>
+<LI>The <tt class="class">FeedParser</tt> class was introduced, and the <tt class="class">Parser</tt>
+ class was implemented in terms of the <tt class="class">FeedParser</tt>. All parsing
+ therefore is non-strict, and parsing will make a best effort never to
+ raise an exception. Problems found while parsing messages are stored in
+ the message's <var>defect</var> attribute.
+
+<P>
+</LI>
+<LI>All aspects of the API which raised <tt class="exception">DeprecationWarning</tt>s in
+ version 2 have been removed. These include the <var>_encoder</var> argument
+ to the <tt class="class">MIMEText</tt> constructor, the <tt class="method">Message.add_payload()</tt>
+ method, the <tt class="function">Utils.dump_address_pair()</tt> function, and the
+ functions <tt class="function">Utils.decode()</tt> and <tt class="function">Utils.encode()</tt>.
+
+<P>
+</LI>
+<LI>New <tt class="exception">DeprecationWarning</tt>s have been added to:
+ <tt class="method">Generator.__call__()</tt>, <tt class="method">Message.get_type()</tt>,
+ <tt class="method">Message.get_main_type()</tt>, <tt class="method">Message.get_subtype()</tt>, and
+ the <var>strict</var> argument to the <tt class="class">Parser</tt> class. These are
+ expected to be removed in future versions.
+
+<P>
+</LI>
+<LI>Support for Pythons earlier than 2.3 has been removed.
+</LI>
+</UL>
+
+<P>
+Here are the differences between <tt class="module">email</tt> version 2 and version 1:
+
+<P>
+
+<UL>
+<LI>The <tt class="module">email.Header</tt> and <tt class="module">email.Charset</tt> modules
+ have been added.
+
+<P>
+</LI>
+<LI>The pickle format for <tt class="class">Message</tt> instances has changed.
+ Since this was never (and still isn't) formally defined, this
+ isn't considered a backward incompatibility. However if your
+ application pickles and unpickles <tt class="class">Message</tt> instances, be
+ aware that in <tt class="module">email</tt> version 2, <tt class="class">Message</tt>
+ instances now have private variables <var>_charset</var> and
+ <var>_default_type</var>.
+
+<P>
+</LI>
+<LI>Several methods in the <tt class="class">Message</tt> class have been
+ deprecated, or their signatures changed. Also, many new methods
+ have been added. See the documentation for the <tt class="class">Message</tt>
+ class for details. The changes should be completely backward
+ compatible.
+
+<P>
+</LI>
+<LI>The object structure has changed in the face of
+ <span class="mimetype">message/rfc822</span> content types. In <tt class="module">email</tt>
+ version 1, such a type would be represented by a scalar payload,
+ i.e. the container message's <tt class="method">is_multipart()</tt> returned
+ false, <tt class="method">get_payload()</tt> was not a list object, but a single
+ <tt class="class">Message</tt> instance.
+
+<P>
+This structure was inconsistent with the rest of the package, so
+ the object representation for <span class="mimetype">message/rfc822</span> content
+ types was changed. In <tt class="module">email</tt> version 2, the container
+ <em>does</em> return <code>True</code> from <tt class="method">is_multipart()</tt>, and
+ <tt class="method">get_payload()</tt> returns a list containing a single
+ <tt class="class">Message</tt> item.
+
+<P>
+Note that this is one place that backward compatibility could
+ not be completely maintained. However, if you're already
+ testing the return type of <tt class="method">get_payload()</tt>, you should be
+ fine. You just need to make sure your code doesn't do a
+ <tt class="method">set_payload()</tt> with a <tt class="class">Message</tt> instance on a
+ container with a content type of <span class="mimetype">message/rfc822</span>.
+
+<P>
+</LI>
+<LI>The <tt class="class">Parser</tt> constructor's <var>strict</var> argument was
+ added, and its <tt class="method">parse()</tt> and <tt class="method">parsestr()</tt> methods
+ grew a <var>headersonly</var> argument. The <var>strict</var> flag was
+ also added to functions <tt class="function">email.message_from_file()</tt>
+ and <tt class="function">email.message_from_string()</tt>.
+
+<P>
+</LI>
+<LI><tt class="method">Generator.__call__()</tt> is deprecated; use
+ <tt class="method">Generator.flatten()</tt> instead. The <tt class="class">Generator</tt>
+ class has also grown the <tt class="method">clone()</tt> method.
+
+<P>
+</LI>
+<LI>The <tt class="class">DecodedGenerator</tt> class in the
+ <tt class="module">email.Generator</tt> module was added.
+
+<P>
+</LI>
+<LI>The intermediate base classes <tt class="class">MIMENonMultipart</tt> and
+ <tt class="class">MIMEMultipart</tt> have been added, and interposed in the
+ class hierarchy for most of the other MIME-related derived
+ classes.
+
+<P>
+</LI>
+<LI>The <var>_encoder</var> argument to the <tt class="class">MIMEText</tt> constructor
+ has been deprecated. Encoding now happens implicitly based
+ on the <var>_charset</var> argument.
+
+<P>
+</LI>
+<LI>The following functions in the <tt class="module">email.Utils</tt> module have
+ been deprecated: <tt class="function">dump_address_pairs()</tt>,
+ <tt class="function">decode()</tt>, and <tt class="function">encode()</tt>. The following
+ functions have been added to the module:
+ <tt class="function">make_msgid()</tt>, <tt class="function">decode_rfc2231()</tt>,
+ <tt class="function">encode_rfc2231()</tt>, and <tt class="function">decode_params()</tt>.
+
+<P>
+</LI>
+<LI>The non-public function <tt class="function">email.Iterators._structure()</tt>
+ was added.
+</LI>
+</UL>
+
+<P>
+
+<DIV CLASS="navigation">
+<div class='online-navigation'>
+<p></p><hr />
+<table align="center" width="100%" cellpadding="0" cellspacing="2">
+<tr>
+<td class='online-navigation'><a rel="prev" title="2.10 Iterators"
+ href="module-email.iterators.html"><img src='previous.png'
+ border='0' height='32' alt='Previous Page' width='32' /></A></td>
+<td class='online-navigation'><a rel="parent" title="2 email "
+ href="module-email.html"><img src='up.png'
+ border='0' height='32' alt='Up One Level' width='32' /></A></td>
+<td class='online-navigation'><a rel="next" title="2.12 Differences from mimelib"
+ href="node17.html"><img src='next.png'
+ border='0' height='32' alt='Next Page' width='32' /></A></td>
+<td align="center" width="100%">email Package Reference</td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+<td class='online-navigation'><img src='blank.png'
+ border='0' height='32' alt='' width='32' /></td>
+</tr></table>
+<div class='online-navigation'>
+<b class="navlabel">Previous:</b>
+<a class="sectref" rel="prev" href="module-email.iterators.html">2.10 Iterators</A>
+<b class="navlabel">Up:</b>
+<a class="sectref" rel="parent" href="module-email.html">2 email </A>
+<b class="navlabel">Next:</b>
+<a class="sectref" rel="next" href="node17.html">2.12 Differences from mimelib</A>
+</div>
+</div>
+<hr />
+<span class="release-info">Release 4.0, documentation updated on March 5, 2006.</span>
+</DIV>
+<!--End of Navigation Panel-->
+
+</BODY>
+</HTML>
Modified: sandbox/trunk/emailpkg/4_0/docs/index.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/index.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/index.html Sun Mar 5 21:27:55 2006
@@ -87,7 +87,7 @@
<LI><A href="module-email.errors.html">2.8 Exception and Defect classes</a>
<LI><A href="module-email.utils.html">2.9 Miscellaneous utilities</a>
<LI><A href="module-email.iterators.html">2.10 Iterators</a>
-<LI><A href="node16.html">2.11 Package History</a>
+<LI><A href="email-pkg-history.html">2.11 Package History</a>
<LI><A href="node17.html">2.12 Differences from <tt class="module">mimelib</tt></a>
<LI><A href="node18.html">2.13 Examples</a>
</ul>
Modified: sandbox/trunk/emailpkg/4_0/docs/mimelib.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/mimelib.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/mimelib.html Sun Mar 5 21:27:55 2006
@@ -87,7 +87,7 @@
<LI><A href="module-email.errors.html">2.8 Exception and Defect classes</a>
<LI><A href="module-email.utils.html">2.9 Miscellaneous utilities</a>
<LI><A href="module-email.iterators.html">2.10 Iterators</a>
-<LI><A href="node16.html">2.11 Package History</a>
+<LI><A href="email-pkg-history.html">2.11 Package History</a>
<LI><A href="node17.html">2.12 Differences from <tt class="module">mimelib</tt></a>
<LI><A href="node18.html">2.13 Examples</a>
</ul>
Modified: sandbox/trunk/emailpkg/4_0/docs/mimelib.pdf
==============================================================================
Binary files. No diff available.
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.encoders.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.encoders.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.encoders.html Sun Mar 5 21:27:55 2006
@@ -77,7 +77,7 @@
Encodes the payload into quoted-printable form and sets the
<span class="mailheader">Content-Transfer-Encoding:</span> header to
<code>quoted-printable</code><A NAME="tex2html35"
- HREF="#foot2098"><SUP>2</SUP></A>.
+ HREF="#foot2099"><SUP>2</SUP></A>.
This is a good encoding to use when most of your payload is normal
printable data, but contains a few unprintable characters.
</dl>
@@ -117,7 +117,7 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot2098">...quoted-printable</A><A
+<DT><A NAME="foot2099">...quoted-printable</A><A
href="module-email.encoders.html#tex2html35"><SUP>2</SUP></A></DT>
<DD>Note that encoding with
<tt class="method">encode_quopri()</tt> also encodes all tabs and space characters in
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.errors.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.errors.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.errors.html Sun Mar 5 21:27:55 2006
@@ -79,7 +79,7 @@
<td><nobr><b><span class="typelabel">exception</span> <tt id='l2h-117' xml:id='l2h-117' class="exception">HeaderParseError</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
-Raised under some error conditions when parsing the <a class="rfc" id='rfcref-3262' xml:id='rfcref-3262'
+Raised under some error conditions when parsing the <a class="rfc" id='rfcref-3288' xml:id='rfcref-3288'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> headers of
a message, this class is derived from <tt class="exception">MessageParseError</tt>.
It can be raised from the <tt class="method">Parser.parse()</tt> or
@@ -87,9 +87,9 @@
<P>
Situations where it can be raised include finding an envelope
-header after the first <a class="rfc" id='rfcref-3264' xml:id='rfcref-3264'
+header after the first <a class="rfc" id='rfcref-3290' xml:id='rfcref-3290'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> header of the message, finding a
-continuation line before the first <a class="rfc" id='rfcref-3266' xml:id='rfcref-3266'
+continuation line before the first <a class="rfc" id='rfcref-3292' xml:id='rfcref-3292'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> header is found, or finding
a line in the headers which is neither a header or a continuation
line.
@@ -100,7 +100,7 @@
<td><nobr><b><span class="typelabel">exception</span> <tt id='l2h-118' xml:id='l2h-118' class="exception">BoundaryError</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
-Raised under some error conditions when parsing the <a class="rfc" id='rfcref-3268' xml:id='rfcref-3268'
+Raised under some error conditions when parsing the <a class="rfc" id='rfcref-3294' xml:id='rfcref-3294'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> headers of
a message, this class is derived from <tt class="exception">MessageParseError</tt>.
It can be raised from the <tt class="method">Parser.parse()</tt> or
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.generator.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.generator.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.generator.html Sun Mar 5 21:27:55 2006
@@ -102,7 +102,7 @@
<var>maxheaderlen</var> (in characters, with tabs expanded to 8 spaces),
the header will be split as defined in the <tt class="module">email.header.Header</tt>
class. Set to zero to disable header wrapping. The default is 78, as
-recommended (but not required) by <a class="rfc" id='rfcref-3163' xml:id='rfcref-3163'
+recommended (but not required) by <a class="rfc" id='rfcref-3189' xml:id='rfcref-3189'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>.
</dl>
@@ -121,7 +121,7 @@
<P>
Optional <var>unixfrom</var> is a flag that forces the printing of the
-envelope header delimiter before the first <a class="rfc" id='rfcref-3165' xml:id='rfcref-3165'
+envelope header delimiter before the first <a class="rfc" id='rfcref-3191' xml:id='rfcref-3191'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> header of the
root message object. If the root object has no envelope header, a
standard one is crafted. By default, this is set to <code>False</code> to
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.header.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.header.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.header.html Sun Mar 5 21:27:55 2006
@@ -52,12 +52,12 @@
<A NAME="module-email.header"></A>
<P>
-<a class="rfc" id='rfcref-3195' xml:id='rfcref-3195'
+<a class="rfc" id='rfcref-3221' xml:id='rfcref-3221'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> is the base standard that describes the format of email
-messages. It derives from the older <a class="rfc" id='rfcref-3197' xml:id='rfcref-3197'
+messages. It derives from the older <a class="rfc" id='rfcref-3223' xml:id='rfcref-3223'
href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> standard which came
into widespread use at a time when most email was composed of ASCII
-characters only. <a class="rfc" id='rfcref-3199' xml:id='rfcref-3199'
+characters only. <a class="rfc" id='rfcref-3225' xml:id='rfcref-3225'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> is a specification written assuming email
contains only 7-bit ASCII characters.
@@ -67,12 +67,12 @@
be used in email messages. The base standard still requires email
messages to be transferred using only 7-bit ASCII characters, so a
slew of RFCs have been written describing how to encode email
-containing non-ASCII characters into <a class="rfc" id='rfcref-3201' xml:id='rfcref-3201'
+containing non-ASCII characters into <a class="rfc" id='rfcref-3227' xml:id='rfcref-3227'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-compliant format.
-These RFCs include <a class="rfc" id='rfcref-3203' xml:id='rfcref-3203'
-href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>, <a class="rfc" id='rfcref-3205' xml:id='rfcref-3205'
-href="http://www.faqs.org/rfcs/rfc2046.html">RFC 2046</a>, <a class="rfc" id='rfcref-3207' xml:id='rfcref-3207'
-href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>, and <a class="rfc" id='rfcref-3209' xml:id='rfcref-3209'
+These RFCs include <a class="rfc" id='rfcref-3229' xml:id='rfcref-3229'
+href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>, <a class="rfc" id='rfcref-3231' xml:id='rfcref-3231'
+href="http://www.faqs.org/rfcs/rfc2046.html">RFC 2046</a>, <a class="rfc" id='rfcref-3233' xml:id='rfcref-3233'
+href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>, and <a class="rfc" id='rfcref-3235' xml:id='rfcref-3235'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>.
The <tt class="module">email</tt> package supports these standards in its
<tt class="module">email.header</tt> and <tt class="module">email.charset</tt> modules.
@@ -101,7 +101,7 @@
non-ASCII character? We did this by creating a <tt class="class">Header</tt>
instance and passing in the character set that the byte string was
encoded in. When the subsequent <tt class="class">Message</tt> instance was
-flattened, the <span class="mailheader">Subject:</span> field was properly <a class="rfc" id='rfcref-3211' xml:id='rfcref-3211'
+flattened, the <span class="mailheader">Subject:</span> field was properly <a class="rfc" id='rfcref-3237' xml:id='rfcref-3237'
href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>
encoded. MIME-aware mail readers would show this header using the
embedded ISO-8859-1 character.
@@ -149,7 +149,7 @@
taken into account for the first line of a long, split header.
<P>
-Optional <var>continuation_ws</var> must be <a class="rfc" id='rfcref-3213' xml:id='rfcref-3213'
+Optional <var>continuation_ws</var> must be <a class="rfc" id='rfcref-3239' xml:id='rfcref-3239'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-compliant folding
whitespace, and is usually either a space or a hard tab character.
This character will be prepended to continuation lines.
@@ -183,8 +183,8 @@
<P>
If <var>s</var> is a Unicode string, then <var>charset</var> is a hint
specifying the character set of the characters in the string. In this
-case, when producing an <a class="rfc" id='rfcref-3215' xml:id='rfcref-3215'
-href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-compliant header using <a class="rfc" id='rfcref-3217' xml:id='rfcref-3217'
+case, when producing an <a class="rfc" id='rfcref-3241' xml:id='rfcref-3241'
+href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-compliant header using <a class="rfc" id='rfcref-3243' xml:id='rfcref-3243'
href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>
rules, the Unicode string will be encoded using the following charsets
in order: <code>us-ascii</code>, the <var>charset</var> hint, <code>utf-8</code>. The
@@ -204,9 +204,9 @@
wrapping long lines and encapsulating non-ASCII parts in base64 or
quoted-printable encodings. Optional <var>splitchars</var> is a string
containing characters to split long ASCII lines on, in rough support
-of <a class="rfc" id='rfcref-3219' xml:id='rfcref-3219'
+of <a class="rfc" id='rfcref-3245' xml:id='rfcref-3245'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>'s <em>highest level syntactic breaks</em>. This doesn't
-affect <a class="rfc" id='rfcref-3221' xml:id='rfcref-3221'
+affect <a class="rfc" id='rfcref-3247' xml:id='rfcref-3247'
href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a> encoded lines.
</dl>
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.html Sun Mar 5 21:27:55 2006
@@ -60,22 +60,22 @@
<P>
The <tt class="module">email</tt> package is a library for managing email messages,
-including MIME and other <a class="rfc" id='rfcref-3061' xml:id='rfcref-3061'
+including MIME and other <a class="rfc" id='rfcref-3087' xml:id='rfcref-3087'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-based message documents. It
subsumes most of the functionality in several older standard modules
such as <tt class="module"><a href="module-rfc822.html">rfc822</a></tt>, <tt class="module"><a href="module-mimetools.html">mimetools</a></tt>,
<tt class="module"><a href="module-multifile.html">multifile</a></tt>, and other non-standard packages such as
<tt class="module">mimecntl</tt>. It is specifically <em>not</em> designed to do any
-sending of email messages to SMTP (<a class="rfc" id='rfcref-3063' xml:id='rfcref-3063'
+sending of email messages to SMTP (<a class="rfc" id='rfcref-3089' xml:id='rfcref-3089'
href="http://www.faqs.org/rfcs/rfc2821.html">RFC 2821</a>), NNTP, or other servers; those
are functions of modules such as <tt class="module"><a href="module-smtplib.html">smtplib</a></tt> and <tt class="module"><a href="module-nntplib.html">nntplib</a></tt>.
The <tt class="module">email</tt> package attempts to be as RFC-compliant as possible,
-supporting in addition to <a class="rfc" id='rfcref-3065' xml:id='rfcref-3065'
+supporting in addition to <a class="rfc" id='rfcref-3091' xml:id='rfcref-3091'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>, such MIME-related RFCs as
-<a class="rfc" id='rfcref-3067' xml:id='rfcref-3067'
-href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>, <a class="rfc" id='rfcref-3069' xml:id='rfcref-3069'
-href="http://www.faqs.org/rfcs/rfc2046.html">RFC 2046</a>, <a class="rfc" id='rfcref-3071' xml:id='rfcref-3071'
-href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>, and <a class="rfc" id='rfcref-3073' xml:id='rfcref-3073'
+<a class="rfc" id='rfcref-3093' xml:id='rfcref-3093'
+href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>, <a class="rfc" id='rfcref-3095' xml:id='rfcref-3095'
+href="http://www.faqs.org/rfcs/rfc2046.html">RFC 2046</a>, <a class="rfc" id='rfcref-3097' xml:id='rfcref-3097'
+href="http://www.faqs.org/rfcs/rfc2047.html">RFC 2047</a>, and <a class="rfc" id='rfcref-3099' xml:id='rfcref-3099'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>.
<P>
@@ -149,7 +149,7 @@
<LI><A href="module-email.errors.html">2.8 Exception and Defect classes</a>
<LI><A href="module-email.utils.html">2.9 Miscellaneous utilities</a>
<LI><A href="module-email.iterators.html">2.10 Iterators</a>
-<LI><A href="node16.html">2.11 Package History</a>
+<LI><A href="email-pkg-history.html">2.11 Package History</a>
<LI><A href="node17.html">2.12 Differences from <tt class="module">mimelib</tt></a>
<LI><A href="node18.html">2.13 Examples</a>
</ul>
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.iterators.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.iterators.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.iterators.html Sun Mar 5 21:27:55 2006
@@ -5,10 +5,10 @@
<link rel="first" href="mimelib.html" title='email Package Reference' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
-<link rel="next" href="node16.html" />
+<link rel="next" href="email-pkg-history.html" />
<link rel="prev" href="module-email.utils.html" />
<link rel="parent" href="module-email.html" />
-<link rel="next" href="node16.html" />
+<link rel="next" href="email-pkg-history.html" />
<meta name='aesop' content='information' />
<title>2.10 Iterators</title>
</head>
@@ -24,7 +24,7 @@
href="module-email.html"><img src='up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.11 Package History"
- href="node16.html"><img src='next.png'
+ href="email-pkg-history.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">email Package Reference</td>
<td class='online-navigation'><img src='blank.png'
@@ -40,7 +40,7 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">2 email </A>
<b class="navlabel">Next:</b>
-<a class="sectref" rel="next" href="node16.html">2.11 Package History</A>
+<a class="sectref" rel="next" href="email-pkg-history.html">2.11 Package History</A>
</div>
<hr /></div>
</DIV>
@@ -147,7 +147,7 @@
href="module-email.html"><img src='up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.11 Package History"
- href="node16.html"><img src='next.png'
+ href="email-pkg-history.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">email Package Reference</td>
<td class='online-navigation'><img src='blank.png'
@@ -163,7 +163,7 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">2 email </A>
<b class="navlabel">Next:</b>
-<a class="sectref" rel="next" href="node16.html">2.11 Package History</A>
+<a class="sectref" rel="next" href="email-pkg-history.html">2.11 Package History</A>
</div>
</div>
<hr />
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.message.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.message.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.message.html Sun Mar 5 21:27:55 2006
@@ -60,7 +60,7 @@
<P>
Conceptually, a <tt class="class">Message</tt> object consists of <em>headers</em> and
-<em>payloads</em>. Headers are <a class="rfc" id='rfcref-3120' xml:id='rfcref-3120'
+<em>payloads</em>. Headers are <a class="rfc" id='rfcref-3146' xml:id='rfcref-3146'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> style field names and
values where the field name and value are separated by a colon. The
colon is not part of either the field name or the field value.
@@ -260,7 +260,7 @@
<P>
The following methods implement a mapping-like interface for accessing
-the message's <a class="rfc" id='rfcref-3122' xml:id='rfcref-3122'
+the message's <a class="rfc" id='rfcref-3148' xml:id='rfcref-3148'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> headers. Note that there are some
semantic differences between these methods and a normal mapping
(i.e. dictionary) interface. For example, in a dictionary there are
@@ -467,17 +467,17 @@
lower case of the form <span class="mimetype">maintype/subtype</span>. If there was no
<span class="mailheader">Content-Type:</span> header in the message the default type as
given by <tt class="method">get_default_type()</tt> will be returned. Since
-according to <a class="rfc" id='rfcref-3124' xml:id='rfcref-3124'
+according to <a class="rfc" id='rfcref-3150' xml:id='rfcref-3150'
href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>, messages always have a default type,
<tt class="method">get_content_type()</tt> will always return a value.
<P>
-<a class="rfc" id='rfcref-3126' xml:id='rfcref-3126'
+<a class="rfc" id='rfcref-3152' xml:id='rfcref-3152'
href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a> defines a message's default type to be
<span class="mimetype">text/plain</span> unless it appears inside a
<span class="mimetype">multipart/digest</span> container, in which case it would be
<span class="mimetype">message/rfc822</span>. If the <span class="mailheader">Content-Type:</span> header
-has an invalid type specification, <a class="rfc" id='rfcref-3128' xml:id='rfcref-3128'
+has an invalid type specification, <a class="rfc" id='rfcref-3154' xml:id='rfcref-3154'
href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a> mandates that the
default type be <span class="mimetype">text/plain</span>.
@@ -592,7 +592,7 @@
<P>
Parameter keys are always compared case insensitively. The return
value can either be a string, or a 3-tuple if the parameter was
-<a class="rfc" id='rfcref-3130' xml:id='rfcref-3130'
+<a class="rfc" id='rfcref-3156' xml:id='rfcref-3156'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a> encoded. When it's a 3-tuple, the elements of the value are of
the form <code>(CHARSET, LANGUAGE, VALUE)</code>. Note that both <code>CHARSET</code> and
<code>LANGUAGE</code> can be <code>None</code>, in which case you should consider
@@ -601,7 +601,7 @@
<P>
If your application doesn't care whether the parameter was encoded as in
-<a class="rfc" id='rfcref-3132' xml:id='rfcref-3132'
+<a class="rfc" id='rfcref-3158' xml:id='rfcref-3158'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>, you can collapse the parameter value by calling
<tt class="function">email.Utils.collapse_rfc2231_value()</tt>, passing in the return value
from <tt class="method">get_param()</tt>. This will return a suitably decoded Unicode string
@@ -639,7 +639,7 @@
parameter already exists in the header, its value will be replaced
with <var>value</var>. If the <span class="mailheader">Content-Type:</span> header as not yet
been defined for this message, it will be set to <span class="mimetype">text/plain</span>
-and the new parameter value will be appended as per <a class="rfc" id='rfcref-3134' xml:id='rfcref-3134'
+and the new parameter value will be appended as per <a class="rfc" id='rfcref-3160' xml:id='rfcref-3160'
href="http://www.faqs.org/rfcs/rfc2045.html">RFC 2045</a>.
<P>
@@ -650,7 +650,7 @@
<P>
If optional <var>charset</var> is specified, the parameter will be encoded
-according to <a class="rfc" id='rfcref-3136' xml:id='rfcref-3136'
+according to <a class="rfc" id='rfcref-3162' xml:id='rfcref-3162'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>. Optional <var>language</var> specifies the RFC
2231 language, defaulting to the empty string. Both <var>charset</var> and
<var>language</var> should be strings.
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.mime.text.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.mime.text.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.mime.text.html Sun Mar 5 21:27:55 2006
@@ -121,7 +121,7 @@
<td><var></var><big>[</big><var>subtype</var><big>[</big><var>,
boundary</var><big>[</big><var>, _subparts</var><big>[</big><var>, _params</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
-Module: <tt class="module">email.mmime.multipart</tt>
+Module: <tt class="module">email.mime.multipart</tt>
<P>
A subclass of <tt class="class">MIMEBase</tt>, this is an intermediate base class for
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.parser.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.parser.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.parser.html Sun Mar 5 21:27:55 2006
@@ -79,7 +79,7 @@
an email message from a socket). The <tt class="class">FeedParser</tt> can consume and parse
the message incrementally, and only returns the root object when you close the
parser<A NAME="tex2html17"
- HREF="#foot976"><SUP>1</SUP></A>.
+ HREF="#foot977"><SUP>1</SUP></A>.
<P>
Note that the parser can be extended in limited ways, and of course
@@ -91,7 +91,7 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot976">...
+<DT><A NAME="foot977">...
parser</A><A
href="module-email.parser.html#tex2html17"><SUP>1</SUP></A></DT>
<DD>As of email package version 3.0, introduced in
Modified: sandbox/trunk/emailpkg/4_0/docs/module-email.utils.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/module-email.utils.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/module-email.utils.html Sun Mar 5 21:27:55 2006
@@ -125,11 +125,11 @@
<td><nobr><b><tt id='l2h-126' xml:id='l2h-126' class="function">parsedate</tt></b>(</nobr></td>
<td><var>date</var>)</td></tr></table></dt>
<dd>
-Attempts to parse a date according to the rules in <a class="rfc" id='rfcref-3290' xml:id='rfcref-3290'
+Attempts to parse a date according to the rules in <a class="rfc" id='rfcref-3316' xml:id='rfcref-3316'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>.
however, some mailers don't follow that format as specified, so
<tt class="function">parsedate()</tt> tries to guess correctly in such cases.
-<var>date</var> is a string containing an <a class="rfc" id='rfcref-3292' xml:id='rfcref-3292'
+<var>date</var> is a string containing an <a class="rfc" id='rfcref-3318' xml:id='rfcref-3318'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a> date, such as
<code>"Mon, 20 Nov 1995 19:12:08 -0500"</code>. If it succeeds in parsing
the date, <tt class="function">parsedate()</tt> returns a 9-tuple that can be passed
@@ -148,7 +148,7 @@
that can be passed directly to <tt class="function">time.mktime()</tt>, and the tenth
is the offset of the date's timezone from UTC (which is the official
term for Greenwich Mean Time)<A NAME="tex2html40"
- HREF="#foot2387"><SUP>3</SUP></A>. If the input
+ HREF="#foot2388"><SUP>3</SUP></A>. If the input
string has no timezone, the last element of the tuple returned is
<code>None</code>. Note that fields 6, 7, and 8 of the result tuple are not
usable.
@@ -173,7 +173,7 @@
<td><nobr><b><tt id='l2h-129' xml:id='l2h-129' class="function">formatdate</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>timeval</var><big>[</big><var>, localtime</var><big>]</big><var></var><big>[</big><var>, usegmt</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
-Returns a date string as per <a class="rfc" id='rfcref-3294' xml:id='rfcref-3294'
+Returns a date string as per <a class="rfc" id='rfcref-3320' xml:id='rfcref-3320'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>, e.g.:
<P>
@@ -207,7 +207,7 @@
<td><nobr><b><tt id='l2h-130' xml:id='l2h-130' class="function">make_msgid</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>idstring</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
-Returns a string suitable for an <a class="rfc" id='rfcref-3296' xml:id='rfcref-3296'
+Returns a string suitable for an <a class="rfc" id='rfcref-3322' xml:id='rfcref-3322'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>-compliant
<span class="mailheader">Message-ID:</span> header. Optional <var>idstring</var> if given, is
a string used to strengthen the uniqueness of the message id.
@@ -218,7 +218,7 @@
<td><nobr><b><tt id='l2h-131' xml:id='l2h-131' class="function">decode_rfc2231</tt></b>(</nobr></td>
<td><var>s</var>)</td></tr></table></dt>
<dd>
-Decode the string <var>s</var> according to <a class="rfc" id='rfcref-3298' xml:id='rfcref-3298'
+Decode the string <var>s</var> according to <a class="rfc" id='rfcref-3324' xml:id='rfcref-3324'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>.
</dl>
@@ -227,7 +227,7 @@
<td><nobr><b><tt id='l2h-132' xml:id='l2h-132' class="function">encode_rfc2231</tt></b>(</nobr></td>
<td><var>s</var><big>[</big><var>, charset</var><big>[</big><var>, language</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
-Encode the string <var>s</var> according to <a class="rfc" id='rfcref-3300' xml:id='rfcref-3300'
+Encode the string <var>s</var> according to <a class="rfc" id='rfcref-3326' xml:id='rfcref-3326'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>. Optional
<var>charset</var> and <var>language</var>, if given is the character set name
and language name to use. If neither is given, <var>s</var> is returned
@@ -241,14 +241,14 @@
<td><var>value</var><big>[</big><var>, errors</var><big>[</big><var>,
fallback_charset</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
-When a header parameter is encoded in <a class="rfc" id='rfcref-3302' xml:id='rfcref-3302'
+When a header parameter is encoded in <a class="rfc" id='rfcref-3328' xml:id='rfcref-3328'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a> format,
<tt class="method">Message.get_param()</tt> may return a 3-tuple containing the character
set, language, and value. <tt class="function">collapse_rfc2231_value()</tt> turns this into
a unicode string. Optional <var>errors</var> is passed to the <var>errors</var>
argument of the built-in <tt class="function">unicode()</tt> function; it defaults to
<code>replace</code>. Optional <var>fallback_charset</var> specifies the character set
-to use if the one in the <a class="rfc" id='rfcref-3304' xml:id='rfcref-3304'
+to use if the one in the <a class="rfc" id='rfcref-3330' xml:id='rfcref-3330'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a> header is not known by Python; it defaults
to <code>us-ascii</code>.
@@ -263,7 +263,7 @@
<td><nobr><b><tt id='l2h-134' xml:id='l2h-134' class="function">decode_params</tt></b>(</nobr></td>
<td><var>params</var>)</td></tr></table></dt>
<dd>
-Decode parameters list according to <a class="rfc" id='rfcref-3306' xml:id='rfcref-3306'
+Decode parameters list according to <a class="rfc" id='rfcref-3332' xml:id='rfcref-3332'
href="http://www.faqs.org/rfcs/rfc2231.html">RFC 2231</a>. <var>params</var> is a
sequence of 2-tuples containing elements of the form
<code>(content-type, string-value)</code>.
@@ -291,12 +291,12 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot2387">... Time)</A><A
+<DT><A NAME="foot2388">... Time)</A><A
href="module-email.utils.html#tex2html40"><SUP>3</SUP></A></DT>
<DD>Note that the sign of the timezone
offset is the opposite of the sign of the <code>time.timezone</code>
variable for the same timezone; the latter variable follows the
-POSIX standard while this module follows <a class="rfc" id='rfcref-3281' xml:id='rfcref-3281'
+POSIX standard while this module follows <a class="rfc" id='rfcref-3307' xml:id='rfcref-3307'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>.
</DD>
Modified: sandbox/trunk/emailpkg/4_0/docs/node1.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/node1.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/node1.html Sun Mar 5 21:27:55 2006
@@ -71,7 +71,8 @@
<UL>
<LI>Deprecation and ``version added'' notes are relative to the
- Python version a feature was added or deprecated.
+ Python version a feature was added or deprecated. See
+ the package history in section <A href="email-pkg-history.html#email-pkg-history">2.11</A> for details.
<P>
</LI>
Modified: sandbox/trunk/emailpkg/4_0/docs/node17.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/node17.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/node17.html Sun Mar 5 21:27:55 2006
@@ -6,7 +6,7 @@
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node18.html" />
-<link rel="prev" href="node16.html" />
+<link rel="prev" href="email-pkg-history.html" />
<link rel="parent" href="module-email.html" />
<link rel="next" href="node18.html" />
<meta name='aesop' content='information' />
@@ -18,7 +18,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.11 Package History"
- href="node16.html"><img src='previous.png'
+ href="email-pkg-history.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2 email "
href="module-email.html"><img src='up.png'
@@ -36,7 +36,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
-<a class="sectref" rel="prev" href="node16.html">2.11 Package History</A>
+<a class="sectref" rel="prev" href="email-pkg-history.html">2.11 Package History</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">2 email </A>
<b class="navlabel">Next:</b>
@@ -191,7 +191,7 @@
a <tt class="class">Message</tt> instance containing separate <tt class="class">Message</tt>
subparts for each header block in the delivery status
notification<A NAME="tex2html52"
- HREF="#foot2697"><SUP>4</SUP></A>.
+ HREF="#foot2719"><SUP>4</SUP></A>.
<P>
The <tt class="class">Generator</tt> class has no differences in its public
@@ -251,11 +251,11 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot2697">...
+<DT><A NAME="foot2719">...
notification</A><A
HREF="node17.html#tex2html52"><SUP>4</SUP></A></DT>
<DD>Delivery Status Notifications (DSN) are defined
-in <a class="rfc" id='rfcref-3320' xml:id='rfcref-3320'
+in <a class="rfc" id='rfcref-3346' xml:id='rfcref-3346'
href="http://www.faqs.org/rfcs/rfc1894.html">RFC 1894</a>.
</DD>
@@ -266,7 +266,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.11 Package History"
- href="node16.html"><img src='previous.png'
+ href="email-pkg-history.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2 email "
href="module-email.html"><img src='up.png'
@@ -284,7 +284,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
-<a class="sectref" rel="prev" href="node16.html">2.11 Package History</A>
+<a class="sectref" rel="prev" href="email-pkg-history.html">2.11 Package History</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">2 email </A>
<b class="navlabel">Next:</b>
Modified: sandbox/trunk/emailpkg/4_0/docs/node18.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/node18.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/node18.html Sun Mar 5 21:27:55 2006
@@ -136,7 +136,7 @@
Here's an example of how to send the entire contents of a directory as
an email message:
<A NAME="tex2html54"
- HREF="#foot2688"><SUP>5</SUP></A>
+ HREF="#foot2708"><SUP>5</SUP></A>
<P>
<div class="verbatim">
<pre>#!/usr/bin/env python
@@ -337,7 +337,7 @@
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
-<DT><A NAME="foot2688">... message:</A><A
+<DT><A NAME="foot2708">... message:</A><A
HREF="node18.html#tex2html54"><SUP>5</SUP></A></DT>
<DD>Thanks to Matthew Dixon Cowles for the original inspiration
and examples.
Modified: sandbox/trunk/emailpkg/4_0/docs/node6.html
==============================================================================
--- sandbox/trunk/emailpkg/4_0/docs/node6.html (original)
+++ sandbox/trunk/emailpkg/4_0/docs/node6.html Sun Mar 5 21:27:55 2006
@@ -105,7 +105,7 @@
on file-like objects.
<P>
-The text contained in <var>fp</var> must be formatted as a block of <a class="rfc" id='rfcref-3153' xml:id='rfcref-3153'
+The text contained in <var>fp</var> must be formatted as a block of <a class="rfc" id='rfcref-3179' xml:id='rfcref-3179'
href="http://www.faqs.org/rfcs/rfc2822.html">RFC 2822</a>
style headers and header continuation lines, optionally preceded by a
envelope header. The header block is terminated either by the
Modified: sandbox/trunk/emailpkg/4_0/email/__init__.py
==============================================================================
--- sandbox/trunk/emailpkg/4_0/email/__init__.py (original)
+++ sandbox/trunk/emailpkg/4_0/email/__init__.py Sun Mar 5 21:27:55 2006
@@ -4,7 +4,7 @@
"""A package for parsing, handling, and generating email messages."""
-__version__ = '4.0a1'
+__version__ = '4.0a2'
__all__ = [
# Old names
Modified: sandbox/trunk/emailpkg/4_0/manual/Makefile
==============================================================================
--- sandbox/trunk/emailpkg/4_0/manual/Makefile (original)
+++ sandbox/trunk/emailpkg/4_0/manual/Makefile Sun Mar 5 21:27:55 2006
@@ -1,2 +1,3 @@
all:
mkhowto --html --pdf --dir ../docs mimelib.tex
+ mv -f mimelib.pdf ../docs
Modified: sandbox/trunk/emailpkg/4_0/manual/email.tex
==============================================================================
--- sandbox/trunk/emailpkg/4_0/manual/email.tex (original)
+++ sandbox/trunk/emailpkg/4_0/manual/email.tex Sun Mar 5 21:27:55 2006
@@ -89,18 +89,21 @@
\subsection{Iterators}
\input{emailiter}
-\subsection{Package History}
+\subsection{Package History\label{email-pkg-history}}
-Version 1 of the \module{email} package was bundled with Python
-releases up to Python 2.2.1. Version 2 was developed for the Python
-2.3 release, and backported to Python 2.2.2. It was also available as
-a separate distutils-based package, and is compatible back to Python 2.1.
-
-\module{email} version 3.0 was released with Python 2.4 and as a separate
-distutils-based package. It is compatible back to Python 2.3.
-
-\module{email} version 4.0 was released with Python 2.5 and as a separate
-distutils-based package. It is also compatible back to Python 2.3.
+This table describes the release history of the email package, corresponding
+to the version of Python that the package was released with. For purposes of
+this document, when you see a note about change or added versions, these refer
+to the Python version the change was made it, \emph{not} the email package
+version. This table also describes the Python compatibility of each version
+of the package.
+
+\begin{tableiii}{l|l|l}{constant}{email version}{distributed with}{compatible with}
+\lineiii{1.x}{Python 2.2.0 to Python 2.2.1}{\emph{no longer supported}}
+\lineiii{2.5}{Python 2.2.2+ and Python 2.3}{Python 2.1 to 2.5}
+\lineiii{3.0}{Python 2.4}{Python 2.3 to 2.5}
+\lineiii{4.0}{Python 2.5}{Python 2.3 to 2.5}
+\end{tableiii}
Here are the major differences between \module{email} verson 4 and version 3:
@@ -117,6 +120,9 @@
\emph{Note that the version 3 names will continue to work until Python
2.6}.
+\item The \module{email.mime.application} module was added, which contains the
+ \class{MIMEApplication} class.
+
\item Methods that were deprecated in version 3 have been removed. These
include \method{Generator.__call__()}, \method{Message.get_type()},
\method{Message.get_main_type()}, \method{Message.get_subtype()}.
Modified: sandbox/trunk/emailpkg/4_0/manual/emailmimebase.tex
==============================================================================
--- sandbox/trunk/emailpkg/4_0/manual/emailmimebase.tex (original)
+++ sandbox/trunk/emailpkg/4_0/manual/emailmimebase.tex Sun Mar 5 21:27:55 2006
@@ -57,7 +57,7 @@
\begin{classdesc}{MIMEMultipart}{\optional{subtype\optional{,
boundary\optional{, _subparts\optional{, _params}}}}}
-Module: \module{email.mmime.multipart}
+Module: \module{email.mime.multipart}
A subclass of \class{MIMEBase}, this is an intermediate base class for
MIME messages that are \mimetype{multipart}. Optional \var{_subtype}
Modified: sandbox/trunk/emailpkg/4_0/manual/mimelib.tex
==============================================================================
--- sandbox/trunk/emailpkg/4_0/manual/mimelib.tex (original)
+++ sandbox/trunk/emailpkg/4_0/manual/mimelib.tex Sun Mar 5 21:27:55 2006
@@ -51,7 +51,8 @@
\begin{itemize}
\item Deprecation and ``version added'' notes are relative to the
- Python version a feature was added or deprecated.
+ Python version a feature was added or deprecated. See
+ the package history in section \ref{email-pkg-history} for details.
\item If you're reading this documentation as part of the
standalone \module{email} package, some of the internal links to
More information about the Python-checkins
mailing list