Edit File: quopri.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.15. quopri — Encode and decode MIME quoted-printable data — 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. Internet Data Handling" href="netdata.html" /> <link rel="next" title="18.16. uu — Encode and decode uuencode files" href="uu.html" /> <link rel="prev" title="18.14. binascii — Convert between binary and ASCII" href="binascii.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="uu.html" title="18.16. uu — Encode and decode uuencode files" accesskey="N">next</a> |</li> <li class="right" > <a href="binascii.html" title="18.14. binascii — Convert between binary and ASCII" 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" accesskey="U">18. Internet Data Handling</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-quopri"> <span id="quopri-encode-and-decode-mime-quoted-printable-data"></span><h1>18.15. <a class="reference internal" href="#module-quopri" title="quopri: Encode and decode files using the MIME quoted-printable encoding."><tt class="xref py py-mod docutils literal"><span class="pre">quopri</span></tt></a> — Encode and decode MIME quoted-printable data<a class="headerlink" href="#module-quopri" title="Permalink to this headline">¶</a></h1> <p id="index-0"><strong>Source code:</strong> <a class="reference external" href="http://hg.python.org/cpython/file/2.7/Lib/quopri.py">Lib/quopri.py</a></p> <hr class="docutils" /> <p>This module performs quoted-printable transport encoding and decoding, as defined in <span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1521.html"><strong>RFC 1521</strong></a>: “MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies”. The quoted-printable encoding is designed for data where there are relatively few nonprintable characters; the base64 encoding scheme available via the <a class="reference internal" href="base64.html#module-base64" title="base64: RFC 3548: Base16, Base32, Base64 Data Encodings"><tt class="xref py py-mod docutils literal"><span class="pre">base64</span></tt></a> module is more compact if there are many such characters, as when sending a graphics file.</p> <dl class="function"> <dt id="quopri.decode"> <tt class="descclassname">quopri.</tt><tt class="descname">decode</tt><big>(</big><em>input</em>, <em>output</em><span class="optional">[</span>, <em>header</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#quopri.decode" title="Permalink to this definition">¶</a></dt> <dd><p>Decode the contents of the <em>input</em> file and write the resulting decoded binary data to the <em>output</em> file. <em>input</em> and <em>output</em> must either be file objects or objects that mimic the file object interface. <em>input</em> will be read until <tt class="docutils literal"><span class="pre">input.readline()</span></tt> returns an empty string. If the optional argument <em>header</em> is present and true, underscore will be decoded as space. This is used to decode “Q”-encoded headers as described in <span class="target" id="index-2"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1522.html"><strong>RFC 1522</strong></a>: “MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text”.</p> </dd></dl> <dl class="function"> <dt id="quopri.encode"> <tt class="descclassname">quopri.</tt><tt class="descname">encode</tt><big>(</big><em>input</em>, <em>output</em>, <em>quotetabs</em><big>)</big><a class="headerlink" href="#quopri.encode" title="Permalink to this definition">¶</a></dt> <dd><p>Encode the contents of the <em>input</em> file and write the resulting quoted-printable data to the <em>output</em> file. <em>input</em> and <em>output</em> must either be file objects or objects that mimic the file object interface. <em>input</em> will be read until <tt class="docutils literal"><span class="pre">input.readline()</span></tt> returns an empty string. <em>quotetabs</em> is a flag which controls whether to encode embedded spaces and tabs; when true it encodes such embedded whitespace, and when false it leaves them unencoded. Note that spaces and tabs appearing at the end of lines are always encoded, as per <span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1521.html"><strong>RFC 1521</strong></a>.</p> </dd></dl> <dl class="function"> <dt id="quopri.decodestring"> <tt class="descclassname">quopri.</tt><tt class="descname">decodestring</tt><big>(</big><em>s</em><span class="optional">[</span>, <em>header</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#quopri.decodestring" title="Permalink to this definition">¶</a></dt> <dd><p>Like <a class="reference internal" href="#quopri.decode" title="quopri.decode"><tt class="xref py py-func docutils literal"><span class="pre">decode()</span></tt></a>, except that it accepts a source string and returns the corresponding decoded string.</p> </dd></dl> <dl class="function"> <dt id="quopri.encodestring"> <tt class="descclassname">quopri.</tt><tt class="descname">encodestring</tt><big>(</big><em>s</em><span class="optional">[</span>, <em>quotetabs</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#quopri.encodestring" title="Permalink to this definition">¶</a></dt> <dd><p>Like <a class="reference internal" href="#quopri.encode" title="quopri.encode"><tt class="xref py py-func docutils literal"><span class="pre">encode()</span></tt></a>, except that it accepts a source string and returns the corresponding encoded string. <em>quotetabs</em> is optional (defaulting to 0), and is passed straight through to <a class="reference internal" href="#quopri.encode" title="quopri.encode"><tt class="xref py py-func docutils literal"><span class="pre">encode()</span></tt></a>.</p> </dd></dl> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <a class="reference internal" href="mimify.html#module-mimify" title="mimify: Mimification and unmimification of mail messages. (deprecated)"><tt class="xref py py-mod docutils literal"><span class="pre">mimify</span></tt></a></dt> <dd>General utilities for processing of MIME messages.</dd> <dt>Module <a class="reference internal" href="base64.html#module-base64" title="base64: RFC 3548: Base16, Base32, Base64 Data Encodings"><tt class="xref py py-mod docutils literal"><span class="pre">base64</span></tt></a></dt> <dd>Encode and decode MIME base64 data</dd> </dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="binascii.html" title="previous chapter">18.14. <tt class="docutils literal"><span class="pre">binascii</span></tt> — Convert between binary and ASCII</a></p> <h4>Next topic</h4> <p class="topless"><a href="uu.html" title="next chapter">18.16. <tt class="docutils literal"><span class="pre">uu</span></tt> — Encode and decode uuencode files</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/quopri.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="uu.html" title="18.16. uu — Encode and decode uuencode files" >next</a> |</li> <li class="right" > <a href="binascii.html" title="18.14. binascii — Convert between binary and ASCII" >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> </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>