Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
關注 1
收藏 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
分支: master
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/imaplib.html

986 line
89KB
原始文件 永久連結 Blame 歷史記錄 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="imaplib — IMAP4 protocol client" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/imaplib.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/imaplib.py This module defines three classes, IMAP4, IMAP4_SSL and IMAP4_stream, which encapsulate a connection to an IMAP4 server and implement a large subset of the IMAP4rev1 cli..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/imaplib.py This module defines three classes, IMAP4, IMAP4_SSL and IMAP4_stream, which encapsulate a connection to an IMAP4 server and implement a large subset of the IMAP4rev1 cli..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>imaplib — IMAP4 protocol client &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="smtplib — SMTP protocol client" href="smtplib.html" />

  39.     <link rel="prev" title="poplib — POP3 protocol client" href="poplib.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/imaplib.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code> — IMAP4 protocol client</a><ul>

  99. <li><a class="reference internal" href="#imap4-objects">IMAP4 Objects</a></li>

  100. <li><a class="reference internal" href="#imap4-example">IMAP4 Example</a></li>

  101. </ul>

  102. </li>

  103. </ul>

  104. 

  105.   </div>

  106.   <div>

  107.     <h4>Previous topic</h4>

  108.     <p class="topless"><a href="poplib.html"

  109.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">poplib</span></code> — POP3 protocol client</a></p>

  110.   </div>

  111.   <div>

  112.     <h4>Next topic</h4>

  113.     <p class="topless"><a href="smtplib.html"

  114.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">smtplib</span></code> — SMTP protocol client</a></p>

  115.   </div>

  116.   <div role="note" aria-label="source link">

  117.     <h3>This Page</h3>

  118.     <ul class="this-page-menu">

  119.       <li><a href="../bugs.html">Report a Bug</a></li>

  120.       <li>

  121.         <a href="https://github.com/python/cpython/blob/main/Doc/library/imaplib.rst"

  122.             rel="nofollow">Show Source

  123.         </a>

  124.       </li>

  125.     </ul>

  126.   </div>

  127.         </nav>

  128.     </div>

  129. </div>

  130. 

  131.   

  132.     <div class="related" role="navigation" aria-label="related navigation">

  133.       <h3>Navigation</h3>

  134.       <ul>

  135.         <li class="right" style="margin-right: 10px">

  136.           <a href="../genindex.html" title="General Index"

  137.              accesskey="I">index</a></li>

  138.         <li class="right" >

  139.           <a href="../py-modindex.html" title="Python Module Index"

  140.              >modules</a> |</li>

  141.         <li class="right" >

  142.           <a href="smtplib.html" title="smtplib — SMTP protocol client"

  143.              accesskey="N">next</a> |</li>

  144.         <li class="right" >

  145.           <a href="poplib.html" title="poplib — POP3 protocol client"

  146.              accesskey="P">previous</a> |</li>

  147. 

  148.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  149.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  150.           <li class="switchers">

  151.             <div class="language_switcher_placeholder"></div>

  152.             <div class="version_switcher_placeholder"></div>

  153.           </li>

  154.           <li>

  155.               

  156.           </li>

  157.     <li id="cpython-language-and-version">

  158.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  159.     </li>

  160. 

  161.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  162.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  163.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code> — IMAP4 protocol client</a></li>

  164.                 <li class="right">

  165.                     

  166. 

  167.     <div class="inline-search" role="search">

  168.         <form class="inline-search" action="../search.html" method="get">

  169.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  170.           <input type="submit" value="Go" />

  171.         </form>

  172.     </div>

  173.                      |

  174.                 </li>

  175.             <li class="right">

  176. <label class="theme-selector-label">

  177.     Theme

  178.     <select class="theme-selector" oninput="activateTheme(this.value)">

  179.         <option value="auto" selected>Auto</option>

  180.         <option value="light">Light</option>

  181.         <option value="dark">Dark</option>

  182.     </select>

  183. </label> |</li>

  184.             

  185.       </ul>

  186.     </div>    

  187. 

  188.     <div class="document">

  189.       <div class="documentwrapper">

  190.         <div class="bodywrapper">

  191.           <div class="body" role="main">

  192.             

  193.   <section id="module-imaplib">

  194. <span id="imaplib-imap4-protocol-client"></span><h1><a class="reference internal" href="#module-imaplib" title="imaplib: IMAP4 protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code></a> — IMAP4 protocol client<a class="headerlink" href="#module-imaplib" title="Link to this heading">¶</a></h1>

  195. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/imaplib.py">Lib/imaplib.py</a></p>

  196. <hr class="docutils" id="index-0" />

  197. <p>This module defines three classes, <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a>, <a class="reference internal" href="#imaplib.IMAP4_SSL" title="imaplib.IMAP4_SSL"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4_SSL</span></code></a> and

  198. <a class="reference internal" href="#imaplib.IMAP4_stream" title="imaplib.IMAP4_stream"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4_stream</span></code></a>, which encapsulate a connection to an IMAP4 server and

  199. implement a large subset of the IMAP4rev1 client protocol as defined in

  200. <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2060.html"><strong>RFC 2060</strong></a>. It is backward compatible with IMAP4 (<span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1730.html"><strong>RFC 1730</strong></a>) servers, but

  201. note that the <code class="docutils literal notranslate"><span class="pre">STATUS</span></code> command is not supported in IMAP4.</p>

  202. <div class="availability docutils container">

  203. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: not Emscripten, not WASI.</p>

  204. <p>This module does not work or is not available on WebAssembly platforms

  205. <code class="docutils literal notranslate"><span class="pre">wasm32-emscripten</span></code> and <code class="docutils literal notranslate"><span class="pre">wasm32-wasi</span></code>. See

  206. <a class="reference internal" href="intro.html#wasm-availability"><span class="std std-ref">WebAssembly platforms</span></a> for more information.</p>

  207. </div>

  208. <p>Three classes are provided by the <a class="reference internal" href="#module-imaplib" title="imaplib: IMAP4 protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code></a> module, <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> is the

  209. base class:</p>

  210. <dl class="py class">

  211. <dt class="sig sig-object py" id="imaplib.IMAP4">

  212. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">IMAP4</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">IMAP4_PORT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4" title="Link to this definition">¶</a></dt>

  213. <dd><p>This class implements the actual IMAP4 protocol.  The connection is created and

  214. protocol version (IMAP4 or IMAP4rev1) is determined when the instance is

  215. initialized. If <em>host</em> is not specified, <code class="docutils literal notranslate"><span class="pre">''</span></code> (the local host) is used. If

  216. <em>port</em> is omitted, the standard IMAP4 port (143) is used. The optional <em>timeout</em>

  217. parameter specifies a timeout in seconds for the connection attempt.

  218. If timeout is not given or is None, the global default socket timeout is used.</p>

  219. <p>The <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> class supports the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.  When used

  220. like this, the IMAP4 <code class="docutils literal notranslate"><span class="pre">LOGOUT</span></code> command is issued automatically when the

  221. <code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code> statement exits.  E.g.:</p>

  222. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">imaplib</span> <span class="kn">import</span> <span class="n">IMAP4</span>

  223. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">IMAP4</span><span class="p">(</span><span class="s2">&quot;domain.org&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">M</span><span class="p">:</span>

  224. <span class="gp">... </span>    <span class="n">M</span><span class="o">.</span><span class="n">noop</span><span class="p">()</span>

  225. <span class="gp">...</span>

  226. <span class="go">(&#39;OK&#39;, [b&#39;Nothing Accomplished. d25if65hy903weo.87&#39;])</span>

  227. </pre></div>

  228. </div>

  229. <div class="versionchanged">

  230. <p><span class="versionmodified changed">Changed in version 3.5: </span>Support for the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement was added.</p>

  231. </div>

  232. <div class="versionchanged">

  233. <p><span class="versionmodified changed">Changed in version 3.9: </span>The optional <em>timeout</em> parameter was added.</p>

  234. </div>

  235. </dd></dl>

  236. 

  237. <p>Three exceptions are defined as attributes of the <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> class:</p>

  238. <dl class="py exception">

  239. <dt class="sig sig-object py" id="imaplib.IMAP4.error">

  240. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">error</span></span><a class="headerlink" href="#imaplib.IMAP4.error" title="Link to this definition">¶</a></dt>

  241. <dd><p>Exception raised on any errors.  The reason for the exception is passed to the

  242. constructor as a string.</p>

  243. </dd></dl>

  244. 

  245. <dl class="py exception">

  246. <dt class="sig sig-object py" id="imaplib.IMAP4.abort">

  247. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">abort</span></span><a class="headerlink" href="#imaplib.IMAP4.abort" title="Link to this definition">¶</a></dt>

  248. <dd><p>IMAP4 server errors cause this exception to be raised.  This is a sub-class of

  249. <a class="reference internal" href="#imaplib.IMAP4.error" title="imaplib.IMAP4.error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IMAP4.error</span></code></a>.  Note that closing the instance and instantiating a new one

  250. will usually allow recovery from this exception.</p>

  251. </dd></dl>

  252. 

  253. <dl class="py exception">

  254. <dt class="sig sig-object py" id="imaplib.IMAP4.readonly">

  255. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">readonly</span></span><a class="headerlink" href="#imaplib.IMAP4.readonly" title="Link to this definition">¶</a></dt>

  256. <dd><p>This exception is raised when a writable mailbox has its status changed by the

  257. server.  This is a sub-class of <a class="reference internal" href="#imaplib.IMAP4.error" title="imaplib.IMAP4.error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IMAP4.error</span></code></a>.  Some other client now has

  258. write permission, and the mailbox will need to be re-opened to re-obtain write

  259. permission.</p>

  260. </dd></dl>

  261. 

  262. <p>There’s also a subclass for secure connections:</p>

  263. <dl class="py class">

  264. <dt class="sig sig-object py" id="imaplib.IMAP4_SSL">

  265. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">IMAP4_SSL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">IMAP4_SSL_PORT</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4_SSL" title="Link to this definition">¶</a></dt>

  266. <dd><p>This is a subclass derived from <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> that connects over an SSL

  267. encrypted socket (to use this class you need a socket module that was compiled

  268. with SSL support).  If <em>host</em> is not specified, <code class="docutils literal notranslate"><span class="pre">''</span></code> (the local host) is used.

  269. If <em>port</em> is omitted, the standard IMAP4-over-SSL port (993) is used.

  270. <em>ssl_context</em> is a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ssl.SSLContext</span></code></a> object which allows bundling

  271. SSL configuration options, certificates and private keys into a single

  272. (potentially long-lived) structure.  Please read <a class="reference internal" href="ssl.html#ssl-security"><span class="std std-ref">Security considerations</span></a> for

  273. best practices.</p>

  274. <p>The optional <em>timeout</em> parameter specifies a timeout in seconds for the

  275. connection attempt. If timeout is not given or is None, the global default

  276. socket timeout is used.</p>

  277. <div class="versionchanged">

  278. <p><span class="versionmodified changed">Changed in version 3.3: </span><em>ssl_context</em> parameter was added.</p>

  279. </div>

  280. <div class="versionchanged">

  281. <p><span class="versionmodified changed">Changed in version 3.4: </span>The class now supports hostname check with

  282. <a class="reference internal" href="ssl.html#ssl.SSLContext.check_hostname" title="ssl.SSLContext.check_hostname"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ssl.SSLContext.check_hostname</span></code></a> and <em>Server Name Indication</em> (see

  283. <a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-const docutils literal notranslate"><span class="pre">ssl.HAS_SNI</span></code></a>).</p>

  284. </div>

  285. <div class="versionchanged">

  286. <p><span class="versionmodified changed">Changed in version 3.9: </span>The optional <em>timeout</em> parameter was added.</p>

  287. </div>

  288. <div class="versionchanged">

  289. <p><span class="versionmodified changed">Changed in version 3.12: </span>The deprecated <em>keyfile</em> and <em>certfile</em> parameters have been removed.</p>

  290. </div>

  291. </dd></dl>

  292. 

  293. <p>The second subclass allows for connections created by a child process:</p>

  294. <dl class="py class">

  295. <dt class="sig sig-object py" id="imaplib.IMAP4_stream">

  296. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">IMAP4_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4_stream" title="Link to this definition">¶</a></dt>

  297. <dd><p>This is a subclass derived from <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> that connects to the

  298. <code class="docutils literal notranslate"><span class="pre">stdin/stdout</span></code> file descriptors created by passing <em>command</em> to

  299. <code class="docutils literal notranslate"><span class="pre">subprocess.Popen()</span></code>.</p>

  300. </dd></dl>

  301. 

  302. <p>The following utility functions are defined:</p>

  303. <dl class="py function">

  304. <dt class="sig sig-object py" id="imaplib.Internaldate2tuple">

  305. <span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">Internaldate2tuple</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datestr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.Internaldate2tuple" title="Link to this definition">¶</a></dt>

  306. <dd><p>Parse an IMAP4 <code class="docutils literal notranslate"><span class="pre">INTERNALDATE</span></code> string and return corresponding local

  307. time.  The return value is a <a class="reference internal" href="time.html#time.struct_time" title="time.struct_time"><code class="xref py py-class docutils literal notranslate"><span class="pre">time.struct_time</span></code></a> tuple or

  308. <code class="docutils literal notranslate"><span class="pre">None</span></code> if the string has wrong format.</p>

  309. </dd></dl>

  310. 

  311. <dl class="py function">

  312. <dt class="sig sig-object py" id="imaplib.Int2AP">

  313. <span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">Int2AP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.Int2AP" title="Link to this definition">¶</a></dt>

  314. <dd><p>Converts an integer into a bytes representation using characters from the set

  315. [<code class="docutils literal notranslate"><span class="pre">A</span></code> .. <code class="docutils literal notranslate"><span class="pre">P</span></code>].</p>

  316. </dd></dl>

  317. 

  318. <dl class="py function">

  319. <dt class="sig sig-object py" id="imaplib.ParseFlags">

  320. <span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">ParseFlags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flagstr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.ParseFlags" title="Link to this definition">¶</a></dt>

  321. <dd><p>Converts an IMAP4 <code class="docutils literal notranslate"><span class="pre">FLAGS</span></code> response to a tuple of individual flags.</p>

  322. </dd></dl>

  323. 

  324. <dl class="py function">

  325. <dt class="sig sig-object py" id="imaplib.Time2Internaldate">

  326. <span class="sig-prename descclassname"><span class="pre">imaplib.</span></span><span class="sig-name descname"><span class="pre">Time2Internaldate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_time</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.Time2Internaldate" title="Link to this definition">¶</a></dt>

  327. <dd><p>Convert <em>date_time</em> to an IMAP4 <code class="docutils literal notranslate"><span class="pre">INTERNALDATE</span></code> representation.

  328. The return value is a string in the form: <code class="docutils literal notranslate"><span class="pre">&quot;DD-Mmm-YYYY</span> <span class="pre">HH:MM:SS</span>

  329. <span class="pre">+HHMM&quot;</span></code> (including double-quotes).  The <em>date_time</em> argument can

  330. be a number (int or float) representing seconds since epoch (as

  331. returned by <a class="reference internal" href="time.html#time.time" title="time.time"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.time()</span></code></a>), a 9-tuple representing local time

  332. an instance of <a class="reference internal" href="time.html#time.struct_time" title="time.struct_time"><code class="xref py py-class docutils literal notranslate"><span class="pre">time.struct_time</span></code></a> (as returned by

  333. <a class="reference internal" href="time.html#time.localtime" title="time.localtime"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.localtime()</span></code></a>), an aware instance of

  334. <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a>, or a double-quoted string.  In the last

  335. case, it is assumed to already be in the correct format.</p>

  336. </dd></dl>

  337. 

  338. <p>Note that IMAP4 message numbers change as the mailbox changes; in particular,

  339. after an <code class="docutils literal notranslate"><span class="pre">EXPUNGE</span></code> command performs deletions the remaining messages are

  340. renumbered. So it is highly advisable to use UIDs instead, with the UID command.</p>

  341. <p>At the end of the module, there is a test section that contains a more extensive

  342. example of usage.</p>

  343. <div class="admonition seealso">

  344. <p class="admonition-title">See also</p>

  345. <p>Documents describing the protocol, sources for servers

  346. implementing it, by the University of Washington’s IMAP Information Center

  347. can all be found at (<strong>Source Code</strong>) <a class="reference external" href="https://github.com/uw-imap/imap">https://github.com/uw-imap/imap</a> (<strong>Not Maintained</strong>).</p>

  348. </div>

  349. <section id="imap4-objects">

  350. <span id="id1"></span><h2>IMAP4 Objects<a class="headerlink" href="#imap4-objects" title="Link to this heading">¶</a></h2>

  351. <p>All IMAP4rev1 commands are represented by methods of the same name, either

  352. uppercase or lowercase.</p>

  353. <p>All arguments to commands are converted to strings, except for <code class="docutils literal notranslate"><span class="pre">AUTHENTICATE</span></code>,

  354. and the last argument to <code class="docutils literal notranslate"><span class="pre">APPEND</span></code> which is passed as an IMAP4 literal.  If

  355. necessary (the string contains IMAP4 protocol-sensitive characters and isn’t

  356. enclosed with either parentheses or double quotes) each string is quoted.

  357. However, the <em>password</em> argument to the <code class="docutils literal notranslate"><span class="pre">LOGIN</span></code> command is always quoted. If

  358. you want to avoid having an argument string quoted (eg: the <em>flags</em> argument to

  359. <code class="docutils literal notranslate"><span class="pre">STORE</span></code>) then enclose the string in parentheses (eg: <code class="docutils literal notranslate"><span class="pre">r'(\Deleted)'</span></code>).</p>

  360. <p>Each command returns a tuple: <code class="docutils literal notranslate"><span class="pre">(type,</span> <span class="pre">[data,</span> <span class="pre">...])</span></code> where <em>type</em> is usually

  361. <code class="docutils literal notranslate"><span class="pre">'OK'</span></code> or <code class="docutils literal notranslate"><span class="pre">'NO'</span></code>, and <em>data</em> is either the text from the command response,

  362. or mandated results from the command. Each <em>data</em> is either a <code class="docutils literal notranslate"><span class="pre">bytes</span></code>, or a

  363. tuple. If a tuple, then the first part is the header of the response, and the

  364. second part contains the data (ie: ‘literal’ value).</p>

  365. <p>The <em>message_set</em> options to commands below is a string specifying one or more

  366. messages to be acted upon.  It may be a simple message number (<code class="docutils literal notranslate"><span class="pre">'1'</span></code>), a range

  367. of message numbers (<code class="docutils literal notranslate"><span class="pre">'2:4'</span></code>), or a group of non-contiguous ranges separated by

  368. commas (<code class="docutils literal notranslate"><span class="pre">'1:3,6:9'</span></code>).  A range can contain an asterisk to indicate an infinite

  369. upper bound (<code class="docutils literal notranslate"><span class="pre">'3:*'</span></code>).</p>

  370. <p>An <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> instance has the following methods:</p>

  371. <dl class="py method">

  372. <dt class="sig sig-object py" id="imaplib.IMAP4.append">

  373. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.append" title="Link to this definition">¶</a></dt>

  374. <dd><p>Append <em>message</em> to named mailbox.</p>

  375. </dd></dl>

  376. 

  377. <dl class="py method">

  378. <dt class="sig sig-object py" id="imaplib.IMAP4.authenticate">

  379. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">authenticate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mechanism</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authobject</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.authenticate" title="Link to this definition">¶</a></dt>

  380. <dd><p>Authenticate command — requires response processing.</p>

  381. <p><em>mechanism</em> specifies which authentication mechanism is to be used - it should

  382. appear in the instance variable <code class="docutils literal notranslate"><span class="pre">capabilities</span></code> in the form <code class="docutils literal notranslate"><span class="pre">AUTH=mechanism</span></code>.</p>

  383. <p><em>authobject</em> must be a callable object:</p>

  384. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="n">authobject</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>

  385. </pre></div>

  386. </div>

  387. <p>It will be called to process server continuation responses; the <em>response</em>

  388. argument it is passed will be <code class="docutils literal notranslate"><span class="pre">bytes</span></code>.  It should return <code class="docutils literal notranslate"><span class="pre">bytes</span></code> <em>data</em>

  389. that will be base64 encoded and sent to the server.  It should return

  390. <code class="docutils literal notranslate"><span class="pre">None</span></code> if the client abort response <code class="docutils literal notranslate"><span class="pre">*</span></code> should be sent instead.</p>

  391. <div class="versionchanged">

  392. <p><span class="versionmodified changed">Changed in version 3.5: </span>string usernames and passwords are now encoded to <code class="docutils literal notranslate"><span class="pre">utf-8</span></code> instead of

  393. being limited to ASCII.</p>

  394. </div>

  395. </dd></dl>

  396. 

  397. <dl class="py method">

  398. <dt class="sig sig-object py" id="imaplib.IMAP4.check">

  399. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">check</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.check" title="Link to this definition">¶</a></dt>

  400. <dd><p>Checkpoint mailbox on server.</p>

  401. </dd></dl>

  402. 

  403. <dl class="py method">

  404. <dt class="sig sig-object py" id="imaplib.IMAP4.close">

  405. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.close" title="Link to this definition">¶</a></dt>

  406. <dd><p>Close currently selected mailbox. Deleted messages are removed from writable

  407. mailbox. This is the recommended command before <code class="docutils literal notranslate"><span class="pre">LOGOUT</span></code>.</p>

  408. </dd></dl>

  409. 

  410. <dl class="py method">

  411. <dt class="sig sig-object py" id="imaplib.IMAP4.copy">

  412. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_set</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.copy" title="Link to this definition">¶</a></dt>

  413. <dd><p>Copy <em>message_set</em> messages onto end of <em>new_mailbox</em>.</p>

  414. </dd></dl>

  415. 

  416. <dl class="py method">

  417. <dt class="sig sig-object py" id="imaplib.IMAP4.create">

  418. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.create" title="Link to this definition">¶</a></dt>

  419. <dd><p>Create new mailbox named <em>mailbox</em>.</p>

  420. </dd></dl>

  421. 

  422. <dl class="py method">

  423. <dt class="sig sig-object py" id="imaplib.IMAP4.delete">

  424. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.delete" title="Link to this definition">¶</a></dt>

  425. <dd><p>Delete old mailbox named <em>mailbox</em>.</p>

  426. </dd></dl>

  427. 

  428. <dl class="py method">

  429. <dt class="sig sig-object py" id="imaplib.IMAP4.deleteacl">

  430. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">deleteacl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">who</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.deleteacl" title="Link to this definition">¶</a></dt>

  431. <dd><p>Delete the ACLs (remove any rights) set for who on mailbox.</p>

  432. </dd></dl>

  433. 

  434. <dl class="py method">

  435. <dt class="sig sig-object py" id="imaplib.IMAP4.enable">

  436. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">enable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.enable" title="Link to this definition">¶</a></dt>

  437. <dd><p>Enable <em>capability</em> (see <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5161.html"><strong>RFC 5161</strong></a>).  Most capabilities do not need to be

  438. enabled.  Currently only the <code class="docutils literal notranslate"><span class="pre">UTF8=ACCEPT</span></code> capability is supported

  439. (see <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc6855.html"><strong>RFC 6855</strong></a>).</p>

  440. <div class="versionadded">

  441. <p><span class="versionmodified added">New in version 3.5: </span>The <a class="reference internal" href="#imaplib.IMAP4.enable" title="imaplib.IMAP4.enable"><code class="xref py py-meth docutils literal notranslate"><span class="pre">enable()</span></code></a> method itself, and <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc6855.html"><strong>RFC 6855</strong></a> support.</p>

  442. </div>

  443. </dd></dl>

  444. 

  445. <dl class="py method">

  446. <dt class="sig sig-object py" id="imaplib.IMAP4.expunge">

  447. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">expunge</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.expunge" title="Link to this definition">¶</a></dt>

  448. <dd><p>Permanently remove deleted items from selected mailbox. Generates an <code class="docutils literal notranslate"><span class="pre">EXPUNGE</span></code>

  449. response for each deleted message. Returned data contains a list of <code class="docutils literal notranslate"><span class="pre">EXPUNGE</span></code>

  450. message numbers in order received.</p>

  451. </dd></dl>

  452. 

  453. <dl class="py method">

  454. <dt class="sig sig-object py" id="imaplib.IMAP4.fetch">

  455. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">fetch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_set</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_parts</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.fetch" title="Link to this definition">¶</a></dt>

  456. <dd><p>Fetch (parts of) messages.  <em>message_parts</em> should be a string of message part

  457. names enclosed within parentheses, eg: <code class="docutils literal notranslate"><span class="pre">&quot;(UID</span> <span class="pre">BODY[TEXT])&quot;</span></code>.  Returned data

  458. are tuples of message part envelope and data.</p>

  459. </dd></dl>

  460. 

  461. <dl class="py method">

  462. <dt class="sig sig-object py" id="imaplib.IMAP4.getacl">

  463. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">getacl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.getacl" title="Link to this definition">¶</a></dt>

  464. <dd><p>Get the <code class="docutils literal notranslate"><span class="pre">ACL</span></code>s for <em>mailbox</em>. The method is non-standard, but is supported

  465. by the <code class="docutils literal notranslate"><span class="pre">Cyrus</span></code> server.</p>

  466. </dd></dl>

  467. 

  468. <dl class="py method">

  469. <dt class="sig sig-object py" id="imaplib.IMAP4.getannotation">

  470. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">getannotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.getannotation" title="Link to this definition">¶</a></dt>

  471. <dd><p>Retrieve the specified <code class="docutils literal notranslate"><span class="pre">ANNOTATION</span></code>s for <em>mailbox</em>. The method is

  472. non-standard, but is supported by the <code class="docutils literal notranslate"><span class="pre">Cyrus</span></code> server.</p>

  473. </dd></dl>

  474. 

  475. <dl class="py method">

  476. <dt class="sig sig-object py" id="imaplib.IMAP4.getquota">

  477. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">getquota</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.getquota" title="Link to this definition">¶</a></dt>

  478. <dd><p>Get the <code class="docutils literal notranslate"><span class="pre">quota</span></code> <em>root</em>’s resource usage and limits. This method is part of the

  479. IMAP4 QUOTA extension defined in rfc2087.</p>

  480. </dd></dl>

  481. 

  482. <dl class="py method">

  483. <dt class="sig sig-object py" id="imaplib.IMAP4.getquotaroot">

  484. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">getquotaroot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.getquotaroot" title="Link to this definition">¶</a></dt>

  485. <dd><p>Get the list of <code class="docutils literal notranslate"><span class="pre">quota</span></code> <code class="docutils literal notranslate"><span class="pre">roots</span></code> for the named <em>mailbox</em>. This method is part

  486. of the IMAP4 QUOTA extension defined in rfc2087.</p>

  487. </dd></dl>

  488. 

  489. <dl class="py method">

  490. <dt class="sig sig-object py" id="imaplib.IMAP4.list">

  491. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">directory</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.list" title="Link to this definition">¶</a></dt>

  492. <dd><p>List mailbox names in <em>directory</em> matching <em>pattern</em>.  <em>directory</em> defaults to

  493. the top-level mail folder, and <em>pattern</em> defaults to match anything.  Returned

  494. data contains a list of <code class="docutils literal notranslate"><span class="pre">LIST</span></code> responses.</p>

  495. </dd></dl>

  496. 

  497. <dl class="py method">

  498. <dt class="sig sig-object py" id="imaplib.IMAP4.login">

  499. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.login" title="Link to this definition">¶</a></dt>

  500. <dd><p>Identify the client using a plaintext password. The <em>password</em> will be quoted.</p>

  501. </dd></dl>

  502. 

  503. <dl class="py method">

  504. <dt class="sig sig-object py" id="imaplib.IMAP4.login_cram_md5">

  505. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">login_cram_md5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.login_cram_md5" title="Link to this definition">¶</a></dt>

  506. <dd><p>Force use of <code class="docutils literal notranslate"><span class="pre">CRAM-MD5</span></code> authentication when identifying the client to protect

  507. the password.  Will only work if the server <code class="docutils literal notranslate"><span class="pre">CAPABILITY</span></code> response includes the

  508. phrase <code class="docutils literal notranslate"><span class="pre">AUTH=CRAM-MD5</span></code>.</p>

  509. </dd></dl>

  510. 

  511. <dl class="py method">

  512. <dt class="sig sig-object py" id="imaplib.IMAP4.logout">

  513. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">logout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.logout" title="Link to this definition">¶</a></dt>

  514. <dd><p>Shutdown connection to server. Returns server <code class="docutils literal notranslate"><span class="pre">BYE</span></code> response.</p>

  515. <div class="versionchanged">

  516. <p><span class="versionmodified changed">Changed in version 3.8: </span>The method no longer ignores silently arbitrary exceptions.</p>

  517. </div>

  518. </dd></dl>

  519. 

  520. <dl class="py method">

  521. <dt class="sig sig-object py" id="imaplib.IMAP4.lsub">

  522. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">lsub</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&quot;&quot;'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'*'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.lsub" title="Link to this definition">¶</a></dt>

  523. <dd><p>List subscribed mailbox names in directory matching pattern. <em>directory</em>

  524. defaults to the top level directory and <em>pattern</em> defaults to match any mailbox.

  525. Returned data are tuples of message part envelope and data.</p>

  526. </dd></dl>

  527. 

  528. <dl class="py method">

  529. <dt class="sig sig-object py" id="imaplib.IMAP4.myrights">

  530. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">myrights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.myrights" title="Link to this definition">¶</a></dt>

  531. <dd><p>Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).</p>

  532. </dd></dl>

  533. 

  534. <dl class="py method">

  535. <dt class="sig sig-object py" id="imaplib.IMAP4.namespace">

  536. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">namespace</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.namespace" title="Link to this definition">¶</a></dt>

  537. <dd><p>Returns IMAP namespaces as defined in <span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2342.html"><strong>RFC 2342</strong></a>.</p>

  538. </dd></dl>

  539. 

  540. <dl class="py method">

  541. <dt class="sig sig-object py" id="imaplib.IMAP4.noop">

  542. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">noop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.noop" title="Link to this definition">¶</a></dt>

  543. <dd><p>Send <code class="docutils literal notranslate"><span class="pre">NOOP</span></code> to server.</p>

  544. </dd></dl>

  545. 

  546. <dl class="py method">

  547. <dt class="sig sig-object py" id="imaplib.IMAP4.open">

  548. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.open" title="Link to this definition">¶</a></dt>

  549. <dd><p>Opens socket to <em>port</em> at <em>host</em>. The optional <em>timeout</em> parameter

  550. specifies a timeout in seconds for the connection attempt.

  551. If timeout is not given or is None, the global default socket timeout

  552. is used. Also note that if the <em>timeout</em> parameter is set to be zero,

  553. it will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a> to reject creating a non-blocking socket.

  554. This method is implicitly called by the <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a> constructor.

  555. The connection objects established by this method will be used in

  556. the <a class="reference internal" href="#imaplib.IMAP4.read" title="imaplib.IMAP4.read"><code class="xref py py-meth docutils literal notranslate"><span class="pre">IMAP4.read()</span></code></a>, <a class="reference internal" href="#imaplib.IMAP4.readline" title="imaplib.IMAP4.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">IMAP4.readline()</span></code></a>, <a class="reference internal" href="#imaplib.IMAP4.send" title="imaplib.IMAP4.send"><code class="xref py py-meth docutils literal notranslate"><span class="pre">IMAP4.send()</span></code></a>,

  557. and <a class="reference internal" href="#imaplib.IMAP4.shutdown" title="imaplib.IMAP4.shutdown"><code class="xref py py-meth docutils literal notranslate"><span class="pre">IMAP4.shutdown()</span></code></a> methods. You may override this method.</p>

  558. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">imaplib.open</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">host</span></code>, <code class="docutils literal notranslate"><span class="pre">port</span></code>.</p>

  559. <div class="versionchanged">

  560. <p><span class="versionmodified changed">Changed in version 3.9: </span>The <em>timeout</em> parameter was added.</p>

  561. </div>

  562. </dd></dl>

  563. 

  564. <dl class="py method">

  565. <dt class="sig sig-object py" id="imaplib.IMAP4.partial">

  566. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">partial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message_part</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.partial" title="Link to this definition">¶</a></dt>

  567. <dd><p>Fetch truncated part of a message. Returned data is a tuple of message part

  568. envelope and data.</p>

  569. </dd></dl>

  570. 

  571. <dl class="py method">

  572. <dt class="sig sig-object py" id="imaplib.IMAP4.proxyauth">

  573. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">proxyauth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.proxyauth" title="Link to this definition">¶</a></dt>

  574. <dd><p>Assume authentication as <em>user</em>. Allows an authorised administrator to proxy

  575. into any user’s mailbox.</p>

  576. </dd></dl>

  577. 

  578. <dl class="py method">

  579. <dt class="sig sig-object py" id="imaplib.IMAP4.read">

  580. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.read" title="Link to this definition">¶</a></dt>

  581. <dd><p>Reads <em>size</em> bytes from the remote server. You may override this method.</p>

  582. </dd></dl>

  583. 

  584. <dl class="py method">

  585. <dt class="sig sig-object py" id="imaplib.IMAP4.readline">

  586. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">readline</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.readline" title="Link to this definition">¶</a></dt>

  587. <dd><p>Reads one line from the remote server. You may override this method.</p>

  588. </dd></dl>

  589. 

  590. <dl class="py method">

  591. <dt class="sig sig-object py" id="imaplib.IMAP4.recent">

  592. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">recent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.recent" title="Link to this definition">¶</a></dt>

  593. <dd><p>Prompt server for an update. Returned data is <code class="docutils literal notranslate"><span class="pre">None</span></code> if no new messages, else

  594. value of <code class="docutils literal notranslate"><span class="pre">RECENT</span></code> response.</p>

  595. </dd></dl>

  596. 

  597. <dl class="py method">

  598. <dt class="sig sig-object py" id="imaplib.IMAP4.rename">

  599. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">rename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oldmailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newmailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.rename" title="Link to this definition">¶</a></dt>

  600. <dd><p>Rename mailbox named <em>oldmailbox</em> to <em>newmailbox</em>.</p>

  601. </dd></dl>

  602. 

  603. <dl class="py method">

  604. <dt class="sig sig-object py" id="imaplib.IMAP4.response">

  605. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.response" title="Link to this definition">¶</a></dt>

  606. <dd><p>Return data for response <em>code</em> if received, or <code class="docutils literal notranslate"><span class="pre">None</span></code>. Returns the given

  607. code, instead of the usual type.</p>

  608. </dd></dl>

  609. 

  610. <dl class="py method">

  611. <dt class="sig sig-object py" id="imaplib.IMAP4.search">

  612. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">charset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">criterion</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.search" title="Link to this definition">¶</a></dt>

  613. <dd><p>Search mailbox for matching messages.  <em>charset</em> may be <code class="docutils literal notranslate"><span class="pre">None</span></code>, in which case

  614. no <code class="docutils literal notranslate"><span class="pre">CHARSET</span></code> will be specified in the request to the server.  The IMAP

  615. protocol requires that at least one criterion be specified; an exception will be

  616. raised when the server returns an error.  <em>charset</em> must be <code class="docutils literal notranslate"><span class="pre">None</span></code> if

  617. the <code class="docutils literal notranslate"><span class="pre">UTF8=ACCEPT</span></code> capability was enabled using the <a class="reference internal" href="#imaplib.IMAP4.enable" title="imaplib.IMAP4.enable"><code class="xref py py-meth docutils literal notranslate"><span class="pre">enable()</span></code></a>

  618. command.</p>

  619. <p>Example:</p>

  620. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># M is a connected IMAP4 instance...</span>

  621. <span class="n">typ</span><span class="p">,</span> <span class="n">msgnums</span> <span class="o">=</span> <span class="n">M</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;FROM&#39;</span><span class="p">,</span> <span class="s1">&#39;&quot;LDJ&quot;&#39;</span><span class="p">)</span>

  622. 

  623. <span class="c1"># or:</span>

  624. <span class="n">typ</span><span class="p">,</span> <span class="n">msgnums</span> <span class="o">=</span> <span class="n">M</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;(FROM &quot;LDJ&quot;)&#39;</span><span class="p">)</span>

  625. </pre></div>

  626. </div>

  627. </dd></dl>

  628. 

  629. <dl class="py method">

  630. <dt class="sig sig-object py" id="imaplib.IMAP4.select">

  631. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INBOX'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readonly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.select" title="Link to this definition">¶</a></dt>

  632. <dd><p>Select a mailbox. Returned data is the count of messages in <em>mailbox</em>

  633. (<code class="docutils literal notranslate"><span class="pre">EXISTS</span></code> response).  The default <em>mailbox</em> is <code class="docutils literal notranslate"><span class="pre">'INBOX'</span></code>.  If the <em>readonly</em>

  634. flag is set, modifications to the mailbox are not allowed.</p>

  635. </dd></dl>

  636. 

  637. <dl class="py method">

  638. <dt class="sig sig-object py" id="imaplib.IMAP4.send">

  639. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.send" title="Link to this definition">¶</a></dt>

  640. <dd><p>Sends <code class="docutils literal notranslate"><span class="pre">data</span></code> to the remote server. You may override this method.</p>

  641. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">imaplib.send</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>

  642. </dd></dl>

  643. 

  644. <dl class="py method">

  645. <dt class="sig sig-object py" id="imaplib.IMAP4.setacl">

  646. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">setacl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">who</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">what</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.setacl" title="Link to this definition">¶</a></dt>

  647. <dd><p>Set an <code class="docutils literal notranslate"><span class="pre">ACL</span></code> for <em>mailbox</em>. The method is non-standard, but is supported by

  648. the <code class="docutils literal notranslate"><span class="pre">Cyrus</span></code> server.</p>

  649. </dd></dl>

  650. 

  651. <dl class="py method">

  652. <dt class="sig sig-object py" id="imaplib.IMAP4.setannotation">

  653. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">setannotation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.setannotation" title="Link to this definition">¶</a></dt>

  654. <dd><p>Set <code class="docutils literal notranslate"><span class="pre">ANNOTATION</span></code>s for <em>mailbox</em>. The method is non-standard, but is

  655. supported by the <code class="docutils literal notranslate"><span class="pre">Cyrus</span></code> server.</p>

  656. </dd></dl>

  657. 

  658. <dl class="py method">

  659. <dt class="sig sig-object py" id="imaplib.IMAP4.setquota">

  660. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">setquota</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limits</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.setquota" title="Link to this definition">¶</a></dt>

  661. <dd><p>Set the <code class="docutils literal notranslate"><span class="pre">quota</span></code> <em>root</em>’s resource <em>limits</em>. This method is part of the IMAP4

  662. QUOTA extension defined in rfc2087.</p>

  663. </dd></dl>

  664. 

  665. <dl class="py method">

  666. <dt class="sig sig-object py" id="imaplib.IMAP4.shutdown">

  667. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">shutdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.shutdown" title="Link to this definition">¶</a></dt>

  668. <dd><p>Close connection established in <code class="docutils literal notranslate"><span class="pre">open</span></code>.  This method is implicitly

  669. called by <a class="reference internal" href="#imaplib.IMAP4.logout" title="imaplib.IMAP4.logout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">IMAP4.logout()</span></code></a>.  You may override this method.</p>

  670. </dd></dl>

  671. 

  672. <dl class="py method">

  673. <dt class="sig sig-object py" id="imaplib.IMAP4.socket">

  674. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.socket" title="Link to this definition">¶</a></dt>

  675. <dd><p>Returns socket instance used to connect to server.</p>

  676. </dd></dl>

  677. 

  678. <dl class="py method">

  679. <dt class="sig sig-object py" id="imaplib.IMAP4.sort">

  680. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sort_criteria</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_criterion</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.sort" title="Link to this definition">¶</a></dt>

  681. <dd><p>The <code class="docutils literal notranslate"><span class="pre">sort</span></code> command is a variant of <code class="docutils literal notranslate"><span class="pre">search</span></code> with sorting semantics for the

  682. results.  Returned data contains a space separated list of matching message

  683. numbers.</p>

  684. <p>Sort has two arguments before the <em>search_criterion</em> argument(s); a

  685. parenthesized list of <em>sort_criteria</em>, and the searching <em>charset</em>.  Note that

  686. unlike <code class="docutils literal notranslate"><span class="pre">search</span></code>, the searching <em>charset</em> argument is mandatory.  There is also

  687. a <code class="docutils literal notranslate"><span class="pre">uid</span> <span class="pre">sort</span></code> command which corresponds to <code class="docutils literal notranslate"><span class="pre">sort</span></code> the way that <code class="docutils literal notranslate"><span class="pre">uid</span> <span class="pre">search</span></code>

  688. corresponds to <code class="docutils literal notranslate"><span class="pre">search</span></code>.  The <code class="docutils literal notranslate"><span class="pre">sort</span></code> command first searches the mailbox for

  689. messages that match the given searching criteria using the charset argument for

  690. the interpretation of strings in the searching criteria.  It then returns the

  691. numbers of matching messages.</p>

  692. <p>This is an <code class="docutils literal notranslate"><span class="pre">IMAP4rev1</span></code> extension command.</p>

  693. </dd></dl>

  694. 

  695. <dl class="py method">

  696. <dt class="sig sig-object py" id="imaplib.IMAP4.starttls">

  697. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">starttls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssl_context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.starttls" title="Link to this definition">¶</a></dt>

  698. <dd><p>Send a <code class="docutils literal notranslate"><span class="pre">STARTTLS</span></code> command.  The <em>ssl_context</em> argument is optional

  699. and should be a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ssl.SSLContext</span></code></a> object.  This will enable

  700. encryption on the IMAP connection.  Please read <a class="reference internal" href="ssl.html#ssl-security"><span class="std std-ref">Security considerations</span></a> for

  701. best practices.</p>

  702. <div class="versionadded">

  703. <p><span class="versionmodified added">New in version 3.2.</span></p>

  704. </div>

  705. <div class="versionchanged">

  706. <p><span class="versionmodified changed">Changed in version 3.4: </span>The method now supports hostname check with

  707. <a class="reference internal" href="ssl.html#ssl.SSLContext.check_hostname" title="ssl.SSLContext.check_hostname"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ssl.SSLContext.check_hostname</span></code></a> and <em>Server Name Indication</em> (see

  708. <a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-const docutils literal notranslate"><span class="pre">ssl.HAS_SNI</span></code></a>).</p>

  709. </div>

  710. </dd></dl>

  711. 

  712. <dl class="py method">

  713. <dt class="sig sig-object py" id="imaplib.IMAP4.status">

  714. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.status" title="Link to this definition">¶</a></dt>

  715. <dd><p>Request named status conditions for <em>mailbox</em>.</p>

  716. </dd></dl>

  717. 

  718. <dl class="py method">

  719. <dt class="sig sig-object py" id="imaplib.IMAP4.store">

  720. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">store</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_set</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flag_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.store" title="Link to this definition">¶</a></dt>

  721. <dd><p>Alters flag dispositions for messages in mailbox.  <em>command</em> is specified by

  722. section 6.4.6 of <span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2060.html"><strong>RFC 2060</strong></a> as being one of “FLAGS”, “+FLAGS”, or “-FLAGS”,

  723. optionally with a suffix of “.SILENT”.</p>

  724. <p>For example, to set the delete flag on all messages:</p>

  725. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">typ</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">M</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;ALL&#39;</span><span class="p">)</span>

  726. <span class="k">for</span> <span class="n">num</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>

  727.    <span class="n">M</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="s1">&#39;+FLAGS&#39;</span><span class="p">,</span> <span class="s1">&#39;</span><span class="se">\\</span><span class="s1">Deleted&#39;</span><span class="p">)</span>

  728. <span class="n">M</span><span class="o">.</span><span class="n">expunge</span><span class="p">()</span>

  729. </pre></div>

  730. </div>

  731. <div class="admonition note">

  732. <p class="admonition-title">Note</p>

  733. <p>Creating flags containing ‘]’ (for example: “[test]”) violates

  734. <span class="target" id="index-8"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3501.html"><strong>RFC 3501</strong></a> (the IMAP protocol).  However, imaplib has historically

  735. allowed creation of such tags, and popular IMAP servers, such as Gmail,

  736. accept and produce such flags.  There are non-Python programs which also

  737. create such tags.  Although it is an RFC violation and IMAP clients and

  738. servers are supposed to be strict, imaplib nonetheless continues to allow

  739. such tags to be created for backward compatibility reasons, and as of

  740. Python 3.6, handles them if they are sent from the server, since this

  741. improves real-world compatibility.</p>

  742. </div>

  743. </dd></dl>

  744. 

  745. <dl class="py method">

  746. <dt class="sig sig-object py" id="imaplib.IMAP4.subscribe">

  747. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.subscribe" title="Link to this definition">¶</a></dt>

  748. <dd><p>Subscribe to new mailbox.</p>

  749. </dd></dl>

  750. 

  751. <dl class="py method">

  752. <dt class="sig sig-object py" id="imaplib.IMAP4.thread">

  753. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">threading_algorithm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_criterion</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.thread" title="Link to this definition">¶</a></dt>

  754. <dd><p>The <code class="docutils literal notranslate"><span class="pre">thread</span></code> command is a variant of <code class="docutils literal notranslate"><span class="pre">search</span></code> with threading semantics for

  755. the results.  Returned data contains a space separated list of thread members.</p>

  756. <p>Thread members consist of zero or more messages numbers, delimited by spaces,

  757. indicating successive parent and child.</p>

  758. <p>Thread has two arguments before the <em>search_criterion</em> argument(s); a

  759. <em>threading_algorithm</em>, and the searching <em>charset</em>.  Note that unlike

  760. <code class="docutils literal notranslate"><span class="pre">search</span></code>, the searching <em>charset</em> argument is mandatory.  There is also a

  761. <code class="docutils literal notranslate"><span class="pre">uid</span> <span class="pre">thread</span></code> command which corresponds to <code class="docutils literal notranslate"><span class="pre">thread</span></code> the way that <code class="docutils literal notranslate"><span class="pre">uid</span>

  762. <span class="pre">search</span></code> corresponds to <code class="docutils literal notranslate"><span class="pre">search</span></code>.  The <code class="docutils literal notranslate"><span class="pre">thread</span></code> command first searches the

  763. mailbox for messages that match the given searching criteria using the <em>charset</em>

  764. argument for the interpretation of strings in the searching criteria. It then

  765. returns the matching messages threaded according to the specified threading

  766. algorithm.</p>

  767. <p>This is an <code class="docutils literal notranslate"><span class="pre">IMAP4rev1</span></code> extension command.</p>

  768. </dd></dl>

  769. 

  770. <dl class="py method">

  771. <dt class="sig sig-object py" id="imaplib.IMAP4.uid">

  772. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">uid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.uid" title="Link to this definition">¶</a></dt>

  773. <dd><p>Execute command args with messages identified by UID, rather than message

  774. number.  Returns response appropriate to command.  At least one argument must be

  775. supplied; if none are provided, the server will return an error and an exception

  776. will be raised.</p>

  777. </dd></dl>

  778. 

  779. <dl class="py method">

  780. <dt class="sig sig-object py" id="imaplib.IMAP4.unsubscribe">

  781. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">unsubscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mailbox</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.unsubscribe" title="Link to this definition">¶</a></dt>

  782. <dd><p>Unsubscribe from old mailbox.</p>

  783. </dd></dl>

  784. 

  785. <dl class="py method">

  786. <dt class="sig sig-object py" id="imaplib.IMAP4.unselect">

  787. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">unselect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.unselect" title="Link to this definition">¶</a></dt>

  788. <dd><p><a class="reference internal" href="#imaplib.IMAP4.unselect" title="imaplib.IMAP4.unselect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">imaplib.IMAP4.unselect()</span></code></a> frees server’s resources associated with the

  789. selected mailbox and returns the server to the authenticated

  790. state. This command performs the same actions as <a class="reference internal" href="#imaplib.IMAP4.close" title="imaplib.IMAP4.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">imaplib.IMAP4.close()</span></code></a>, except

  791. that no messages are permanently removed from the currently

  792. selected mailbox.</p>

  793. <div class="versionadded">

  794. <p><span class="versionmodified added">New in version 3.9.</span></p>

  795. </div>

  796. </dd></dl>

  797. 

  798. <dl class="py method">

  799. <dt class="sig sig-object py" id="imaplib.IMAP4.xatom">

  800. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">xatom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#imaplib.IMAP4.xatom" title="Link to this definition">¶</a></dt>

  801. <dd><p>Allow simple extension commands notified by server in <code class="docutils literal notranslate"><span class="pre">CAPABILITY</span></code> response.</p>

  802. </dd></dl>

  803. 

  804. <p>The following attributes are defined on instances of <a class="reference internal" href="#imaplib.IMAP4" title="imaplib.IMAP4"><code class="xref py py-class docutils literal notranslate"><span class="pre">IMAP4</span></code></a>:</p>

  805. <dl class="py attribute">

  806. <dt class="sig sig-object py" id="imaplib.IMAP4.PROTOCOL_VERSION">

  807. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">PROTOCOL_VERSION</span></span><a class="headerlink" href="#imaplib.IMAP4.PROTOCOL_VERSION" title="Link to this definition">¶</a></dt>

  808. <dd><p>The most recent supported protocol in the <code class="docutils literal notranslate"><span class="pre">CAPABILITY</span></code> response from the

  809. server.</p>

  810. </dd></dl>

  811. 

  812. <dl class="py attribute">

  813. <dt class="sig sig-object py" id="imaplib.IMAP4.debug">

  814. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">debug</span></span><a class="headerlink" href="#imaplib.IMAP4.debug" title="Link to this definition">¶</a></dt>

  815. <dd><p>Integer value to control debugging output.  The initialize value is taken from

  816. the module variable <code class="docutils literal notranslate"><span class="pre">Debug</span></code>.  Values greater than three trace each command.</p>

  817. </dd></dl>

  818. 

  819. <dl class="py attribute">

  820. <dt class="sig sig-object py" id="imaplib.IMAP4.utf8_enabled">

  821. <span class="sig-prename descclassname"><span class="pre">IMAP4.</span></span><span class="sig-name descname"><span class="pre">utf8_enabled</span></span><a class="headerlink" href="#imaplib.IMAP4.utf8_enabled" title="Link to this definition">¶</a></dt>

  822. <dd><p>Boolean value that is normally <code class="docutils literal notranslate"><span class="pre">False</span></code>, but is set to <code class="docutils literal notranslate"><span class="pre">True</span></code> if an

  823. <a class="reference internal" href="#imaplib.IMAP4.enable" title="imaplib.IMAP4.enable"><code class="xref py py-meth docutils literal notranslate"><span class="pre">enable()</span></code></a> command is successfully issued for the <code class="docutils literal notranslate"><span class="pre">UTF8=ACCEPT</span></code>

  824. capability.</p>

  825. <div class="versionadded">

  826. <p><span class="versionmodified added">New in version 3.5.</span></p>

  827. </div>

  828. </dd></dl>

  829. 

  830. </section>

  831. <section id="imap4-example">

  832. <span id="id2"></span><h2>IMAP4 Example<a class="headerlink" href="#imap4-example" title="Link to this heading">¶</a></h2>

  833. <p>Here is a minimal example (without error checking) that opens a mailbox and

  834. retrieves and prints all messages:</p>

  835. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">getpass</span><span class="o">,</span> <span class="nn">imaplib</span>

  836. 

  837. <span class="n">M</span> <span class="o">=</span> <span class="n">imaplib</span><span class="o">.</span><span class="n">IMAP4</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s1">&#39;example.org&#39;</span><span class="p">)</span>

  838. <span class="n">M</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="n">getpass</span><span class="o">.</span><span class="n">getuser</span><span class="p">(),</span> <span class="n">getpass</span><span class="o">.</span><span class="n">getpass</span><span class="p">())</span>

  839. <span class="n">M</span><span class="o">.</span><span class="n">select</span><span class="p">()</span>

  840. <span class="n">typ</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">M</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;ALL&#39;</span><span class="p">)</span>

  841. <span class="k">for</span> <span class="n">num</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>

  842.     <span class="n">typ</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="n">M</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="s1">&#39;(RFC822)&#39;</span><span class="p">)</span>

  843.     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Message </span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]))</span>

  844. <span class="n">M</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  845. <span class="n">M</span><span class="o">.</span><span class="n">logout</span><span class="p">()</span>

  846. </pre></div>

  847. </div>

  848. </section>

  849. </section>

  850. 

  851. 

  852.             <div class="clearer"></div>

  853.           </div>

  854.         </div>

  855.       </div>

  856.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  857.         <div class="sphinxsidebarwrapper">

  858.   <div>

  859.     <h3><a href="../contents.html">Table of Contents</a></h3>

  860.     <ul>

  861. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code> — IMAP4 protocol client</a><ul>

  862. <li><a class="reference internal" href="#imap4-objects">IMAP4 Objects</a></li>

  863. <li><a class="reference internal" href="#imap4-example">IMAP4 Example</a></li>

  864. </ul>

  865. </li>

  866. </ul>

  867. 

  868.   </div>

  869.   <div>

  870.     <h4>Previous topic</h4>

  871.     <p class="topless"><a href="poplib.html"

  872.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">poplib</span></code> — POP3 protocol client</a></p>

  873.   </div>

  874.   <div>

  875.     <h4>Next topic</h4>

  876.     <p class="topless"><a href="smtplib.html"

  877.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">smtplib</span></code> — SMTP protocol client</a></p>

  878.   </div>

  879.   <div role="note" aria-label="source link">

  880.     <h3>This Page</h3>

  881.     <ul class="this-page-menu">

  882.       <li><a href="../bugs.html">Report a Bug</a></li>

  883.       <li>

  884.         <a href="https://github.com/python/cpython/blob/main/Doc/library/imaplib.rst"

  885.             rel="nofollow">Show Source

  886.         </a>

  887.       </li>

  888.     </ul>

  889.   </div>

  890.         </div>

  891. <div id="sidebarbutton" title="Collapse sidebar">

  892. <span>«</span>

  893. </div>

  894. 

  895.       </div>

  896.       <div class="clearer"></div>

  897.     </div>  

  898.     <div class="related" role="navigation" aria-label="related navigation">

  899.       <h3>Navigation</h3>

  900.       <ul>

  901.         <li class="right" style="margin-right: 10px">

  902.           <a href="../genindex.html" title="General Index"

  903.              >index</a></li>

  904.         <li class="right" >

  905.           <a href="../py-modindex.html" title="Python Module Index"

  906.              >modules</a> |</li>

  907.         <li class="right" >

  908.           <a href="smtplib.html" title="smtplib — SMTP protocol client"

  909.              >next</a> |</li>

  910.         <li class="right" >

  911.           <a href="poplib.html" title="poplib — POP3 protocol client"

  912.              >previous</a> |</li>

  913. 

  914.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  915.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  916.           <li class="switchers">

  917.             <div class="language_switcher_placeholder"></div>

  918.             <div class="version_switcher_placeholder"></div>

  919.           </li>

  920.           <li>

  921.               

  922.           </li>

  923.     <li id="cpython-language-and-version">

  924.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  925.     </li>

  926. 

  927.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  928.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  929.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">imaplib</span></code> — IMAP4 protocol client</a></li>

  930.                 <li class="right">

  931.                     

  932. 

  933.     <div class="inline-search" role="search">

  934.         <form class="inline-search" action="../search.html" method="get">

  935.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  936.           <input type="submit" value="Go" />

  937.         </form>

  938.     </div>

  939.                      |

  940.                 </li>

  941.             <li class="right">

  942. <label class="theme-selector-label">

  943.     Theme

  944.     <select class="theme-selector" oninput="activateTheme(this.value)">

  945.         <option value="auto" selected>Auto</option>

  946.         <option value="light">Light</option>

  947.         <option value="dark">Dark</option>

  948.     </select>

  949. </label> |</li>

  950.             

  951.       </ul>

  952.     </div>  

  953.     <div class="footer">

  954.     &copy; 

  955.       <a href="../copyright.html">

  956.     

  957.     Copyright

  958.     

  959.       </a>

  960.      2001-2024, Python Software Foundation.

  961.     <br />

  962.     This page is licensed under the Python Software Foundation License Version 2.

  963.     <br />

  964.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  965.     <br />

  966.     

  967.       See <a href="/license.html">History and License</a> for more information.<br />

  968.     

  969.     

  970.     <br />

  971. 

  972.     The Python Software Foundation is a non-profit corporation.

  973. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  974. <br />

  975.     <br />

  976.       Last updated on Apr 09, 2024 (13:47 UTC).

  977.     

  978.       <a href="/bugs.html">Found a bug</a>?

  979.     

  980.     <br />

  981. 

  982.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  983.     </div>

  984. 

  985.   </body>

  986. </html>
上海开阖软件有限公司 沪ICP备12045867号-1