|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
<head>
|
|
|
<meta charset="utf-8" />
|
|
|
<title>email.errors: Exception and Defect classes — Python 3.7.4 documentation</title>
|
|
|
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
|
|
|
|
|
<script type="text/javascript" src="../_static/sidebar.js"></script>
|
|
|
|
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
|
title="Search within Python 3.7.4 documentation"
|
|
|
href="../_static/opensearch.xml"/>
|
|
|
<link rel="author" title="About these documents" href="../about.html" />
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
<link rel="copyright" title="Copyright" href="../copyright.html" />
|
|
|
<link rel="next" title="email.headerregistry: Custom Header Objects" href="email.headerregistry.html" />
|
|
|
<link rel="prev" title="email.policy: Policy Objects" href="email.policy.html" />
|
|
|
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
|
|
|
<link rel="canonical" href="https://docs.python.org/3/library/email.errors.html" />
|
|
|
|
|
|
<script type="text/javascript" src="../_static/copybutton.js"></script>
|
|
|
<script type="text/javascript" src="../_static/switchers.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
|
@media only screen {
|
|
|
table.full-width-table {
|
|
|
width: 100%;
|
|
|
}
|
|
|
}
|
|
|
</style>
|
|
|
|
|
|
|
|
|
</head><body>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<h3>Navigation</h3>
|
|
|
<ul>
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
accesskey="I">index</a></li>
|
|
|
<li class="right" >
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
>modules</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="email.headerregistry.html" title="email.headerregistry: Custom Header Objects"
|
|
|
accesskey="N">next</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="email.policy.html" title="email.policy: Policy Objects"
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
<li><img src="../_static/py.png" alt=""
|
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
|
<li>
|
|
|
<span class="language_switcher_placeholder">en</span>
|
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|
|
<a href="../index.html">Documentation </a> »
|
|
|
</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|
|
<li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> »</li>
|
|
|
<li class="nav-item nav-item-3"><a href="email.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> »</li>
|
|
|
<li class="right">
|
|
|
|
|
|
|
|
|
<div class="inline-search" style="display: none" role="search">
|
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|
|
<input type="submit" value="Go" />
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
</form>
|
|
|
</div>
|
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
<div class="document">
|
|
|
<div class="documentwrapper">
|
|
|
<div class="bodywrapper">
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
<div class="section" id="module-email.errors">
|
|
|
<span id="email-errors-exception-and-defect-classes"></span><h1><a class="reference internal" href="#module-email.errors" title="email.errors: The exception classes used by the email package."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.errors</span></code></a>: Exception and Defect classes<a class="headerlink" href="#module-email.errors" title="Permalink to this headline">¶</a></h1>
|
|
|
<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.7/Lib/email/errors.py">Lib/email/errors.py</a></p>
|
|
|
<hr class="docutils" />
|
|
|
<p>The following exception classes are defined in the <a class="reference internal" href="#module-email.errors" title="email.errors: The exception classes used by the email package."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.errors</span></code></a> module:</p>
|
|
|
<dl class="exception">
|
|
|
<dt id="email.errors.MessageError">
|
|
|
<em class="property">exception </em><code class="descclassname">email.errors.</code><code class="descname">MessageError</code><a class="headerlink" href="#email.errors.MessageError" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>This is the base class for all exceptions that the <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code></a> package can
|
|
|
raise. It is derived from the standard <a class="reference internal" href="exceptions.html#Exception" title="Exception"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Exception</span></code></a> class and defines no
|
|
|
additional methods.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="exception">
|
|
|
<dt id="email.errors.MessageParseError">
|
|
|
<em class="property">exception </em><code class="descclassname">email.errors.</code><code class="descname">MessageParseError</code><a class="headerlink" href="#email.errors.MessageParseError" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>This is the base class for exceptions raised by the
|
|
|
<a class="reference internal" href="email.parser.html#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parser</span></code></a> class. It is derived from
|
|
|
<a class="reference internal" href="#email.errors.MessageError" title="email.errors.MessageError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">MessageError</span></code></a>. This class is also used internally by the parser used
|
|
|
by <a class="reference internal" href="email.headerregistry.html#module-email.headerregistry" title="email.headerregistry: Automatic Parsing of headers based on the field name"><code class="xref py py-mod docutils literal notranslate"><span class="pre">headerregistry</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="exception">
|
|
|
<dt id="email.errors.HeaderParseError">
|
|
|
<em class="property">exception </em><code class="descclassname">email.errors.</code><code class="descname">HeaderParseError</code><a class="headerlink" href="#email.errors.HeaderParseError" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Raised under some error conditions when parsing the <span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc5322.html"><strong>RFC 5322</strong></a> headers of a
|
|
|
message, this class is derived from <a class="reference internal" href="#email.errors.MessageParseError" title="email.errors.MessageParseError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">MessageParseError</span></code></a>. The
|
|
|
<a class="reference internal" href="email.message.html#email.message.EmailMessage.set_boundary" title="email.message.EmailMessage.set_boundary"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_boundary()</span></code></a> method will raise this
|
|
|
error if the content type is unknown when the method is called.
|
|
|
<a class="reference internal" href="email.header.html#email.header.Header" title="email.header.Header"><code class="xref py py-class docutils literal notranslate"><span class="pre">Header</span></code></a> may raise this error for certain base64
|
|
|
decoding errors, and when an attempt is made to create a header that appears
|
|
|
to contain an embedded header (that is, there is what is supposed to be a
|
|
|
continuation line that has no leading whitespace and looks like a header).</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="exception">
|
|
|
<dt id="email.errors.BoundaryError">
|
|
|
<em class="property">exception </em><code class="descclassname">email.errors.</code><code class="descname">BoundaryError</code><a class="headerlink" href="#email.errors.BoundaryError" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Deprecated and no longer used.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="exception">
|
|
|
<dt id="email.errors.MultipartConversionError">
|
|
|
<em class="property">exception </em><code class="descclassname">email.errors.</code><code class="descname">MultipartConversionError</code><a class="headerlink" href="#email.errors.MultipartConversionError" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Raised when a payload is added to a <a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> object
|
|
|
using <code class="xref py py-meth docutils literal notranslate"><span class="pre">add_payload()</span></code>, but the payload is already a scalar and the
|
|
|
message’s <em class="mailheader">Content-Type</em> main type is not either
|
|
|
<em class="mimetype">multipart</em> or missing. <a class="reference internal" href="#email.errors.MultipartConversionError" title="email.errors.MultipartConversionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">MultipartConversionError</span></code></a> multiply
|
|
|
inherits from <a class="reference internal" href="#email.errors.MessageError" title="email.errors.MessageError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">MessageError</span></code></a> and the built-in <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.</p>
|
|
|
<p>Since <code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.add_payload()</span></code> is deprecated, this exception is rarely
|
|
|
raised in practice. However the exception may also be raised if the
|
|
|
<a class="reference internal" href="email.compat32-message.html#email.message.Message.attach" title="email.message.Message.attach"><code class="xref py py-meth docutils literal notranslate"><span class="pre">attach()</span></code></a>
|
|
|
method is called on an instance of a class derived from
|
|
|
<a class="reference internal" href="email.mime.html#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> (e.g.
|
|
|
<a class="reference internal" href="email.mime.html#email.mime.image.MIMEImage" title="email.mime.image.MIMEImage"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEImage</span></code></a>).</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<p>Here is the list of the defects that the <a class="reference internal" href="email.parser.html#email.parser.FeedParser" title="email.parser.FeedParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeedParser</span></code></a>
|
|
|
can find while parsing messages. Note that the defects are added to the message
|
|
|
where the problem was found, so for example, if a message nested inside a
|
|
|
<em class="mimetype">multipart/alternative</em> had a malformed header, that nested message
|
|
|
object would have a defect, but the containing messages would not.</p>
|
|
|
<p>All defect classes are subclassed from <code class="xref py py-class docutils literal notranslate"><span class="pre">email.errors.MessageDefect</span></code>.</p>
|
|
|
<ul>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">NoBoundaryInMultipartDefect</span></code> – A message claimed to be a multipart,
|
|
|
but had no <em class="mimetype">boundary</em> parameter.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">StartBoundaryNotFoundDefect</span></code> – The start boundary claimed in the
|
|
|
<em class="mailheader">Content-Type</em> header was never found.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">CloseBoundaryNotFoundDefect</span></code> – A start boundary was found, but
|
|
|
no corresponding close boundary was ever found.</p>
|
|
|
<div class="versionadded">
|
|
|
<p><span class="versionmodified added">New in version 3.3.</span></p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">FirstHeaderLineIsContinuationDefect</span></code> – The message had a continuation
|
|
|
line as its first header line.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">MisplacedEnvelopeHeaderDefect</span></code> - A “Unix From” header was found in the
|
|
|
middle of a header block.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">MissingHeaderBodySeparatorDefect</span></code> - A line was found while parsing
|
|
|
headers that had no leading white space but contained no ‘:’. Parsing
|
|
|
continues assuming that the line represents the first line of the body.</p>
|
|
|
<div class="versionadded">
|
|
|
<p><span class="versionmodified added">New in version 3.3.</span></p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">MalformedHeaderDefect</span></code> – A header was found that was missing a colon,
|
|
|
or was otherwise malformed.</p>
|
|
|
<div class="deprecated">
|
|
|
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span>This defect has not been used for several Python versions.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipartInvariantViolationDefect</span></code> – A message claimed to be a
|
|
|
<em class="mimetype">multipart</em>, but no subparts were found. Note that when a message
|
|
|
has this defect, its <a class="reference internal" href="email.compat32-message.html#email.message.Message.is_multipart" title="email.message.Message.is_multipart"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_multipart()</span></code></a> method may
|
|
|
return false even though its content type claims to be <em class="mimetype">multipart</em>.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidBase64PaddingDefect</span></code> – When decoding a block of base64
|
|
|
encoded bytes, the padding was not correct. Enough padding is added to
|
|
|
perform the decode, but the resulting decoded bytes may be invalid.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidBase64CharactersDefect</span></code> – When decoding a block of base64
|
|
|
encoded bytes, characters outside the base64 alphabet were encountered.
|
|
|
The characters are ignored, but the resulting decoded bytes may be invalid.</p></li>
|
|
|
<li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidBase64LengthDefect</span></code> – When decoding a block of base64 encoded
|
|
|
bytes, the number of non-padding base64 characters was invalid (1 more than
|
|
|
a multiple of 4). The encoded block was kept as-is.</p></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
<h4>Previous topic</h4>
|
|
|
<p class="topless"><a href="email.policy.html"
|
|
|
title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.policy</span></code>: Policy Objects</a></p>
|
|
|
<h4>Next topic</h4>
|
|
|
<p class="topless"><a href="email.headerregistry.html"
|
|
|
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.headerregistry</span></code>: Custom Header Objects</a></p>
|
|
|
<div role="note" aria-label="source link">
|
|
|
<h3>This Page</h3>
|
|
|
<ul class="this-page-menu">
|
|
|
<li><a href="../bugs.html">Report a Bug</a></li>
|
|
|
<li>
|
|
|
<a href="https://github.com/python/cpython/blob/3.7/Doc/library/email.errors.rst"
|
|
|
rel="nofollow">Show Source
|
|
|
</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="clearer"></div>
|
|
|
</div>
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<h3>Navigation</h3>
|
|
|
<ul>
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
>index</a></li>
|
|
|
<li class="right" >
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
>modules</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="email.headerregistry.html" title="email.headerregistry: Custom Header Objects"
|
|
|
>next</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="email.policy.html" title="email.policy: Policy Objects"
|
|
|
>previous</a> |</li>
|
|
|
<li><img src="../_static/py.png" alt=""
|
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
|
<li>
|
|
|
<span class="language_switcher_placeholder">en</span>
|
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|
|
<a href="../index.html">Documentation </a> »
|
|
|
</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|
|
<li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> »</li>
|
|
|
<li class="nav-item nav-item-3"><a href="email.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> »</li>
|
|
|
<li class="right">
|
|
|
|
|
|
|
|
|
<div class="inline-search" style="display: none" role="search">
|
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|
|
<input type="submit" value="Go" />
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
</form>
|
|
|
</div>
|
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="footer">
|
|
|
© <a href="../copyright.html">Copyright</a> 2001-2019, Python Software Foundation.
|
|
|
<br />
|
|
|
The Python Software Foundation is a non-profit corporation.
|
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|
|
<br />
|
|
|
Last updated on Jul 13, 2019.
|
|
|
<a href="../bugs.html">Found a bug</a>?
|
|
|
<br />
|
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.0.1.
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
</html> |