Edit File: email.util.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>18.1.9. email.utils: Miscellaneous utilities — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="18.1. email — An email and MIME handling package" href="email.html" /> <link rel="next" title="18.1.10. email.iterators: Iterators" href="email.iterators.html" /> <link rel="prev" title="18.1.8. email.errors: Exception and Defect classes" href="email.errors.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <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.iterators.html" title="18.1.10. email.iterators: Iterators" accesskey="N">next</a> |</li> <li class="right" > <a href="email.errors.html" title="18.1.8. email.errors: Exception and Defect classes" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" >18. Internet Data Handling</a> »</li> <li><a href="email.html" accesskey="U">18.1. <tt class="docutils literal"><span class="pre">email</span></tt> — An email and MIME handling package</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-email.utils"> <span id="email-utils-miscellaneous-utilities"></span><h1>18.1.9. <a class="reference internal" href="#module-email.utils" title="email.utils: Miscellaneous email package utilities."><tt class="xref py py-mod docutils literal"><span class="pre">email.utils</span></tt></a>: Miscellaneous utilities<a class="headerlink" href="#module-email.utils" title="Permalink to this headline">¶</a></h1> <p>There are several useful utilities provided in the <a class="reference internal" href="#module-email.utils" title="email.utils: Miscellaneous email package utilities."><tt class="xref py py-mod docutils literal"><span class="pre">email.utils</span></tt></a> module:</p> <dl class="function"> <dt id="email.utils.quote"> <tt class="descclassname">email.utils.</tt><tt class="descname">quote</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#email.utils.quote" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new string with backslashes in <em>str</em> replaced by two backslashes, and double quotes replaced by backslash-double quote.</p> </dd></dl> <dl class="function"> <dt id="email.utils.unquote"> <tt class="descclassname">email.utils.</tt><tt class="descname">unquote</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#email.utils.unquote" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new string which is an <em>unquoted</em> version of <em>str</em>. If <em>str</em> ends and begins with double quotes, they are stripped off. Likewise if <em>str</em> ends and begins with angle brackets, they are stripped off.</p> </dd></dl> <dl class="function"> <dt id="email.utils.parseaddr"> <tt class="descclassname">email.utils.</tt><tt class="descname">parseaddr</tt><big>(</big><em>address</em><big>)</big><a class="headerlink" href="#email.utils.parseaddr" title="Permalink to this definition">¶</a></dt> <dd><p>Parse address – which should be the value of some address-containing field such as <em class="mailheader">To</em> or <em class="mailheader">Cc</em> – into its constituent <em>realname</em> and <em>email address</em> parts. Returns a tuple of that information, unless the parse fails, in which case a 2-tuple of <tt class="docutils literal"><span class="pre">('',</span> <span class="pre">'')</span></tt> is returned.</p> </dd></dl> <dl class="function"> <dt id="email.utils.formataddr"> <tt class="descclassname">email.utils.</tt><tt class="descname">formataddr</tt><big>(</big><em>pair</em><big>)</big><a class="headerlink" href="#email.utils.formataddr" title="Permalink to this definition">¶</a></dt> <dd><p>The inverse of <a class="reference internal" href="#email.utils.parseaddr" title="email.utils.parseaddr"><tt class="xref py py-meth docutils literal"><span class="pre">parseaddr()</span></tt></a>, this takes a 2-tuple of the form <tt class="docutils literal"><span class="pre">(realname,</span> <span class="pre">email_address)</span></tt> and returns the string value suitable for a <em class="mailheader">To</em> or <em class="mailheader">Cc</em> header. If the first element of <em>pair</em> is false, then the second element is returned unmodified.</p> </dd></dl> <dl class="function"> <dt id="email.utils.getaddresses"> <tt class="descclassname">email.utils.</tt><tt class="descname">getaddresses</tt><big>(</big><em>fieldvalues</em><big>)</big><a class="headerlink" href="#email.utils.getaddresses" title="Permalink to this definition">¶</a></dt> <dd><p>This method returns a list of 2-tuples of the form returned by <tt class="docutils literal"><span class="pre">parseaddr()</span></tt>. <em>fieldvalues</em> is a sequence of header field values as might be returned by <tt class="xref py py-meth docutils literal"><span class="pre">Message.get_all()</span></tt>. Here’s a simple example that gets all the recipients of a message:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">email.utils</span> <span class="kn">import</span> <span class="n">getaddresses</span> <span class="n">tos</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="s">'to'</span><span class="p">,</span> <span class="p">[])</span> <span class="n">ccs</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="s">'cc'</span><span class="p">,</span> <span class="p">[])</span> <span class="n">resent_tos</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="s">'resent-to'</span><span class="p">,</span> <span class="p">[])</span> <span class="n">resent_ccs</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="s">'resent-cc'</span><span class="p">,</span> <span class="p">[])</span> <span class="n">all_recipients</span> <span class="o">=</span> <span class="n">getaddresses</span><span class="p">(</span><span class="n">tos</span> <span class="o">+</span> <span class="n">ccs</span> <span class="o">+</span> <span class="n">resent_tos</span> <span class="o">+</span> <span class="n">resent_ccs</span><span class="p">)</span> </pre></div> </div> </dd></dl> <dl class="function"> <dt id="email.utils.parsedate"> <tt class="descclassname">email.utils.</tt><tt class="descname">parsedate</tt><big>(</big><em>date</em><big>)</big><a class="headerlink" href="#email.utils.parsedate" title="Permalink to this definition">¶</a></dt> <dd><p>Attempts to parse a date according to the rules in <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>. however, some mailers don’t follow that format as specified, so <a class="reference internal" href="#email.utils.parsedate" title="email.utils.parsedate"><tt class="xref py py-func docutils literal"><span class="pre">parsedate()</span></tt></a> tries to guess correctly in such cases. <em>date</em> is a string containing an <span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> date, such as <tt class="docutils literal"><span class="pre">"Mon,</span> <span class="pre">20</span> <span class="pre">Nov</span> <span class="pre">1995</span> <span class="pre">19:12:08</span> <span class="pre">-0500"</span></tt>. If it succeeds in parsing the date, <a class="reference internal" href="#email.utils.parsedate" title="email.utils.parsedate"><tt class="xref py py-func docutils literal"><span class="pre">parsedate()</span></tt></a> returns a 9-tuple that can be passed directly to <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><tt class="xref py py-func docutils literal"><span class="pre">time.mktime()</span></tt></a>; otherwise <tt class="docutils literal"><span class="pre">None</span></tt> will be returned. Note that indexes 6, 7, and 8 of the result tuple are not usable.</p> </dd></dl> <dl class="function"> <dt id="email.utils.parsedate_tz"> <tt class="descclassname">email.utils.</tt><tt class="descname">parsedate_tz</tt><big>(</big><em>date</em><big>)</big><a class="headerlink" href="#email.utils.parsedate_tz" title="Permalink to this definition">¶</a></dt> <dd><p>Performs the same function as <a class="reference internal" href="#email.utils.parsedate" title="email.utils.parsedate"><tt class="xref py py-func docutils literal"><span class="pre">parsedate()</span></tt></a>, but returns either <tt class="docutils literal"><span class="pre">None</span></tt> or a 10-tuple; the first 9 elements make up a tuple that can be passed directly to <a class="reference internal" href="time.html#time.mktime" title="time.mktime"><tt class="xref py py-func docutils literal"><span class="pre">time.mktime()</span></tt></a>, and the tenth is the offset of the date’s timezone from UTC (which is the official term for Greenwich Mean Time) <a class="footnote-reference" href="#id2" id="id1">[1]</a>. If the input string has no timezone, the last element of the tuple returned is <tt class="docutils literal"><span class="pre">None</span></tt>. Note that indexes 6, 7, and 8 of the result tuple are not usable.</p> </dd></dl> <dl class="function"> <dt id="email.utils.mktime_tz"> <tt class="descclassname">email.utils.</tt><tt class="descname">mktime_tz</tt><big>(</big><em>tuple</em><big>)</big><a class="headerlink" href="#email.utils.mktime_tz" title="Permalink to this definition">¶</a></dt> <dd><p>Turn a 10-tuple as returned by <a class="reference internal" href="#email.utils.parsedate_tz" title="email.utils.parsedate_tz"><tt class="xref py py-func docutils literal"><span class="pre">parsedate_tz()</span></tt></a> into a UTC timestamp. It the timezone item in the tuple is <tt class="docutils literal"><span class="pre">None</span></tt>, assume local time. Minor deficiency: <a class="reference internal" href="#email.utils.mktime_tz" title="email.utils.mktime_tz"><tt class="xref py py-func docutils literal"><span class="pre">mktime_tz()</span></tt></a> interprets the first 8 elements of <em>tuple</em> as a local time and then compensates for the timezone difference. This may yield a slight error around changes in daylight savings time, though not worth worrying about for common use.</p> </dd></dl> <dl class="function"> <dt id="email.utils.formatdate"> <tt class="descclassname">email.utils.</tt><tt class="descname">formatdate</tt><big>(</big><em>[timeval[, localtime][, usegmt]]</em><big>)</big><a class="headerlink" href="#email.utils.formatdate" title="Permalink to this definition">¶</a></dt> <dd><p>Returns a date string as per <span class="target" id="index-2"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>, e.g.:</p> <div class="highlight-python"><pre>Fri, 09 Nov 2001 01:08:47 -0000</pre> </div> <p>Optional <em>timeval</em> if given is a floating point time value as accepted by <a class="reference internal" href="time.html#time.gmtime" title="time.gmtime"><tt class="xref py py-func docutils literal"><span class="pre">time.gmtime()</span></tt></a> and <a class="reference internal" href="time.html#time.localtime" title="time.localtime"><tt class="xref py py-func docutils literal"><span class="pre">time.localtime()</span></tt></a>, otherwise the current time is used.</p> <p>Optional <em>localtime</em> is a flag that when <tt class="docutils literal"><span class="pre">True</span></tt>, interprets <em>timeval</em>, and returns a date relative to the local timezone instead of UTC, properly taking daylight savings time into account. The default is <tt class="docutils literal"><span class="pre">False</span></tt> meaning UTC is used.</p> <p>Optional <em>usegmt</em> is a flag that when <tt class="docutils literal"><span class="pre">True</span></tt>, outputs a date string with the timezone as an ascii string <tt class="docutils literal"><span class="pre">GMT</span></tt>, rather than a numeric <tt class="docutils literal"><span class="pre">-0000</span></tt>. This is needed for some protocols (such as HTTP). This only applies when <em>localtime</em> is <tt class="docutils literal"><span class="pre">False</span></tt>. The default is <tt class="docutils literal"><span class="pre">False</span></tt>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> </dd></dl> <dl class="function"> <dt id="email.utils.make_msgid"> <tt class="descclassname">email.utils.</tt><tt class="descname">make_msgid</tt><big>(</big><span class="optional">[</span><em>idstring</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.utils.make_msgid" title="Permalink to this definition">¶</a></dt> <dd><p>Returns a string suitable for an <span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>-compliant <em class="mailheader">Message-ID</em> header. Optional <em>idstring</em> if given, is a string used to strengthen the uniqueness of the message id.</p> </dd></dl> <dl class="function"> <dt id="email.utils.decode_rfc2231"> <tt class="descclassname">email.utils.</tt><tt class="descname">decode_rfc2231</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#email.utils.decode_rfc2231" title="Permalink to this definition">¶</a></dt> <dd><p>Decode the string <em>s</em> according to <span class="target" id="index-4"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>.</p> </dd></dl> <dl class="function"> <dt id="email.utils.encode_rfc2231"> <tt class="descclassname">email.utils.</tt><tt class="descname">encode_rfc2231</tt><big>(</big><em>s</em><span class="optional">[</span>, <em>charset</em><span class="optional">[</span>, <em>language</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.utils.encode_rfc2231" title="Permalink to this definition">¶</a></dt> <dd><p>Encode the string <em>s</em> according to <span class="target" id="index-5"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>. Optional <em>charset</em> and <em>language</em>, if given is the character set name and language name to use. If neither is given, <em>s</em> is returned as-is. If <em>charset</em> is given but <em>language</em> is not, the string is encoded using the empty string for <em>language</em>.</p> </dd></dl> <dl class="function"> <dt id="email.utils.collapse_rfc2231_value"> <tt class="descclassname">email.utils.</tt><tt class="descname">collapse_rfc2231_value</tt><big>(</big><em>value</em><span class="optional">[</span>, <em>errors</em><span class="optional">[</span>, <em>fallback_charset</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#email.utils.collapse_rfc2231_value" title="Permalink to this definition">¶</a></dt> <dd><p>When a header parameter is encoded in <span class="target" id="index-6"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a> format, <tt class="xref py py-meth docutils literal"><span class="pre">Message.get_param()</span></tt> may return a 3-tuple containing the character set, language, and value. <a class="reference internal" href="#email.utils.collapse_rfc2231_value" title="email.utils.collapse_rfc2231_value"><tt class="xref py py-func docutils literal"><span class="pre">collapse_rfc2231_value()</span></tt></a> turns this into a unicode string. Optional <em>errors</em> is passed to the <em>errors</em> argument of the built-in <a class="reference internal" href="functions.html#unicode" title="unicode"><tt class="xref py py-func docutils literal"><span class="pre">unicode()</span></tt></a> function; it defaults to <tt class="docutils literal"><span class="pre">replace</span></tt>. Optional <em>fallback_charset</em> specifies the character set to use if the one in the <span class="target" id="index-7"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a> header is not known by Python; it defaults to <tt class="docutils literal"><span class="pre">us-ascii</span></tt>.</p> <p>For convenience, if the <em>value</em> passed to <a class="reference internal" href="#email.utils.collapse_rfc2231_value" title="email.utils.collapse_rfc2231_value"><tt class="xref py py-func docutils literal"><span class="pre">collapse_rfc2231_value()</span></tt></a> is not a tuple, it should be a string and it is returned unquoted.</p> </dd></dl> <dl class="function"> <dt id="email.utils.decode_params"> <tt class="descclassname">email.utils.</tt><tt class="descname">decode_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#email.utils.decode_params" title="Permalink to this definition">¶</a></dt> <dd><p>Decode parameters list according to <span class="target" id="index-8"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2231.html"><strong>RFC 2231</strong></a>. <em>params</em> is a sequence of 2-tuples containing elements of the form <tt class="docutils literal"><span class="pre">(content-type,</span> <span class="pre">string-value)</span></tt>.</p> </dd></dl> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.4: </span>The <tt class="xref py py-func docutils literal"><span class="pre">dump_address_pair()</span></tt> function has been removed; use <a class="reference internal" href="#email.utils.formataddr" title="email.utils.formataddr"><tt class="xref py py-func docutils literal"><span class="pre">formataddr()</span></tt></a> instead.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.4: </span>The <tt class="xref py py-func docutils literal"><span class="pre">decode()</span></tt> function has been removed; use the <tt class="xref py py-meth docutils literal"><span class="pre">Header.decode_header()</span></tt> method instead.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.4: </span>The <tt class="xref py py-func docutils literal"><span class="pre">encode()</span></tt> function has been removed; use the <tt class="xref py py-meth docutils literal"><span class="pre">Header.encode()</span></tt> method instead.</p> <p class="rubric">Footnotes</p> <table class="docutils footnote" frame="void" id="id2" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Note that the sign of the timezone offset is the opposite of the sign of the <tt class="docutils literal"><span class="pre">time.timezone</span></tt> variable for the same timezone; the latter variable follows the POSIX standard while this module follows <span class="target" id="index-9"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>.</td></tr> </tbody> </table> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="email.errors.html" title="previous chapter">18.1.8. <tt class="docutils literal"><span class="pre">email.errors</span></tt>: Exception and Defect classes</a></p> <h4>Next topic</h4> <p class="topless"><a href="email.iterators.html" title="next chapter">18.1.10. <tt class="docutils literal"><span class="pre">email.iterators</span></tt>: Iterators</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/email.util.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input 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> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <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.iterators.html" title="18.1.10. email.iterators: Iterators" >next</a> |</li> <li class="right" > <a href="email.errors.html" title="18.1.8. email.errors: Exception and Defect classes" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" >18. Internet Data Handling</a> »</li> <li><a href="email.html" >18.1. <tt class="docutils literal"><span class="pre">email</span></tt> — An email and MIME handling package</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>