parthtamu/rag-code-assistant
0
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="email.iterators: Iterators" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/email.iterators.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="Source code: Lib/email/iterators.py Iterating over a message object tree is fairly easy with the Message.walk method. The email.iterators module provides some useful higher level iterations over me..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_email.iterators_d806a97b.png" />15<meta property="og:image:alt" content="Source code: Lib/email/iterators.py Iterating over a message object tree is fairly easy with the Message.walk method. The email.iterators module provides some useful higher level iterations over me..." />16<meta name="description" content="Source code: Lib/email/iterators.py Iterating over a message object tree is fairly easy with the Message.walk method. The email.iterators module provides some useful higher level iterations over me..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>email.iterators: Iterators — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="json — JSON encoder and decoder" href="json.html" />43 <link rel="prev" title="email.utils: Miscellaneous utilities" href="email.utils.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/email.iterators.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <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>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h4>Previous topic</h4>106 <p class="topless"><a href="email.utils.html"107 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.utils</span></code>: Miscellaneous utilities</a></p>108 </div>109 <div>110 <h4>Next topic</h4>111 <p class="topless"><a href="json.html"112 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code> — JSON encoder and decoder</a></p>113 </div>114 <script>115 document.addEventListener('DOMContentLoaded', () => {116 const title = document.querySelector('meta[property="og:title"]').content;117 const elements = document.querySelectorAll('.improvepage');118 const pageurl = window.location.href.split('?')[0];119 elements.forEach(element => {120 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));121 url.searchParams.set('pagetitle', title);122 url.searchParams.set('pageurl', pageurl);123 url.searchParams.set('pagesource', "library/email.iterators.rst");124 element.href = url.toString();125 });126 });127 </script>128 <div role="note" aria-label="source link">129 <h3>This page</h3>130 <ul class="this-page-menu">131 <li><a href="../bugs.html">Report a bug</a></li>132 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>133 <li>134 <a href="https://github.com/python/cpython/blob/main/Doc/library/email.iterators.rst?plain=1"135 rel="nofollow">Show source136 </a>137 </li>138 139 </ul>140 </div>141 </nav>142 </div>143</div>144 145 146 <div class="related" role="navigation" aria-label="Related">147 <h3>Navigation</h3>148 <ul>149 <li class="right" style="margin-right: 10px">150 <a href="../genindex.html" title="General Index"151 accesskey="I">index</a></li>152 <li class="right" >153 <a href="../py-modindex.html" title="Python Module Index"154 >modules</a> |</li>155 <li class="right" >156 <a href="json.html" title="json — JSON encoder and decoder"157 accesskey="N">next</a> |</li>158 <li class="right" >159 <a href="email.utils.html" title="email.utils: Miscellaneous utilities"160 accesskey="P">previous</a> |</li>161 162 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>163 <li><a href="https://www.python.org/">Python</a> »</li>164 <li class="switchers">165 <div class="language_switcher_placeholder"></div>166 <div class="version_switcher_placeholder"></div>167 </li>168 <li>169 170 </li>171 <li id="cpython-language-and-version">172 <a href="../index.html">3.15.0a6 Documentation</a> »173 </li>174 175 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>176 <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> »</li>177 <li class="nav-item nav-item-3"><a href="email.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> »</li>178 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code>: Iterators</a></li>179 <li class="right">180 181 182 <div class="inline-search" role="search">183 <form class="inline-search" action="../search.html" method="get">184 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">185 <input type="submit" value="Go">186 </form>187 </div>188 |189 </li>190 <li class="right">191<label class="theme-selector-label">192 Theme193 <select class="theme-selector" oninput="activateTheme(this.value)">194 <option value="auto" selected>Auto</option>195 <option value="light">Light</option>196 <option value="dark">Dark</option>197 </select>198</label> |</li>199 200 </ul>201 </div> 202 203 <div class="document">204 <div class="documentwrapper">205 <div class="bodywrapper">206 <div class="body" role="main">207 208 <section id="module-email.iterators">209<span id="email-iterators-iterators"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code>: Iterators<a class="headerlink" href="#module-email.iterators" title="Link to this heading">¶</a></h1>210<p><strong>Source code:</strong> <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/main/Lib/email/iterators.py">Lib/email/iterators.py</a></p>211<hr class="docutils" />212<p>Iterating over a message object tree is fairly easy with the213<a class="reference internal" href="email.compat32-message.html#email.message.Message.walk" title="email.message.Message.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.walk</span></code></a> method. The214<code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code> module provides some useful higher level iterations over215message object trees.</p>216<dl class="py function">217<dt class="sig sig-object py" id="email.iterators.body_line_iterator">218<span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">body_line_iterator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode</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="#email.iterators.body_line_iterator" title="Link to this definition">¶</a></dt>219<dd><p>This iterates over all the payloads in all the subparts of <em>msg</em>, returning the220string payloads line-by-line. It skips over all the subpart headers, and it221skips over any subpart with a payload that isn’t a Python string. This is222somewhat equivalent to reading the flat text representation of the message from223a file using <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a>, skipping over all the224intervening headers.</p>225<p>Optional <em>decode</em> is passed through to <a class="reference internal" href="email.compat32-message.html#email.message.Message.get_payload" title="email.message.Message.get_payload"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.get_payload</span></code></a>.</p>226</dd></dl>227 228<dl class="py function">229<dt class="sig sig-object py" id="email.iterators.typed_subpart_iterator">230<span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">typed_subpart_iterator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maintype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'text'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtype</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="#email.iterators.typed_subpart_iterator" title="Link to this definition">¶</a></dt>231<dd><p>This iterates over all the subparts of <em>msg</em>, returning only those subparts that232match the MIME type specified by <em>maintype</em> and <em>subtype</em>.</p>233<p>Note that <em>subtype</em> is optional; if omitted, then subpart MIME type matching is234done only with the main type. <em>maintype</em> is optional too; it defaults to235<em class="mimetype">text</em>.</p>236<p>Thus, by default <code class="xref py py-func docutils literal notranslate"><span class="pre">typed_subpart_iterator()</span></code> returns each subpart that has a237MIME type of <em class="mimetype">text/*</em>.</p>238</dd></dl>239 240<p>The following function has been added as a useful debugging tool. It should241<em>not</em> be considered part of the supported public interface for the package.</p>242<dl class="py function">243<dt class="sig sig-object py" id="email.iterators._structure">244<span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">_structure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fp</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">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_default</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="#email.iterators._structure" title="Link to this definition">¶</a></dt>245<dd><p>Prints an indented representation of the content types of the message object246structure. For example:</p>247<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">msg</span> <span class="o">=</span> <span class="n">email</span><span class="o">.</span><span class="n">message_from_file</span><span class="p">(</span><span class="n">somefile</span><span class="p">)</span>248<span class="gp">>>> </span><span class="n">_structure</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>249<span class="go">multipart/mixed</span>250<span class="go"> text/plain</span>251<span class="go"> text/plain</span>252<span class="go"> multipart/digest</span>253<span class="go"> message/rfc822</span>254<span class="go"> text/plain</span>255<span class="go"> message/rfc822</span>256<span class="go"> text/plain</span>257<span class="go"> message/rfc822</span>258<span class="go"> text/plain</span>259<span class="go"> message/rfc822</span>260<span class="go"> text/plain</span>261<span class="go"> message/rfc822</span>262<span class="go"> text/plain</span>263<span class="go"> text/plain</span>264</pre></div>265</div>266<p>Optional <em>fp</em> is a file-like object to print the output to. It must be267suitable for Python’s <a class="reference internal" href="functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate"><span class="pre">print()</span></code></a> function. <em>level</em> is used internally.268<em>include_default</em>, if true, prints the default type as well.</p>269</dd></dl>270 271</section>272 273 274 <div class="clearer"></div>275 </div>276 </div>277 </div>278 <div class="sphinxsidebar" role="navigation" aria-label="Main">279 <div class="sphinxsidebarwrapper">280 <div>281 <h4>Previous topic</h4>282 <p class="topless"><a href="email.utils.html"283 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.utils</span></code>: Miscellaneous utilities</a></p>284 </div>285 <div>286 <h4>Next topic</h4>287 <p class="topless"><a href="json.html"288 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code> — JSON encoder and decoder</a></p>289 </div>290 <script>291 document.addEventListener('DOMContentLoaded', () => {292 const title = document.querySelector('meta[property="og:title"]').content;293 const elements = document.querySelectorAll('.improvepage');294 const pageurl = window.location.href.split('?')[0];295 elements.forEach(element => {296 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));297 url.searchParams.set('pagetitle', title);298 url.searchParams.set('pageurl', pageurl);299 url.searchParams.set('pagesource', "library/email.iterators.rst");300 element.href = url.toString();301 });302 });303 </script>304 <div role="note" aria-label="source link">305 <h3>This page</h3>306 <ul class="this-page-menu">307 <li><a href="../bugs.html">Report a bug</a></li>308 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>309 <li>310 <a href="https://github.com/python/cpython/blob/main/Doc/library/email.iterators.rst?plain=1"311 rel="nofollow">Show source312 </a>313 </li>314 315 </ul>316 </div>317 </div>318<div id="sidebarbutton" title="Collapse sidebar">319<span>«</span>320</div>321 322 </div>323 <div class="clearer"></div>324 </div> 325 <div class="related" role="navigation" aria-label="Related">326 <h3>Navigation</h3>327 <ul>328 <li class="right" style="margin-right: 10px">329 <a href="../genindex.html" title="General Index"330 >index</a></li>331 <li class="right" >332 <a href="../py-modindex.html" title="Python Module Index"333 >modules</a> |</li>334 <li class="right" >335 <a href="json.html" title="json — JSON encoder and decoder"336 >next</a> |</li>337 <li class="right" >338 <a href="email.utils.html" title="email.utils: Miscellaneous utilities"339 >previous</a> |</li>340 341 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>342 <li><a href="https://www.python.org/">Python</a> »</li>343 <li class="switchers">344 <div class="language_switcher_placeholder"></div>345 <div class="version_switcher_placeholder"></div>346 </li>347 <li>348 349 </li>350 <li id="cpython-language-and-version">351 <a href="../index.html">3.15.0a6 Documentation</a> »352 </li>353 354 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>355 <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> »</li>356 <li class="nav-item nav-item-3"><a href="email.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> »</li>357 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code>: Iterators</a></li>358 <li class="right">359 360 361 <div class="inline-search" role="search">362 <form class="inline-search" action="../search.html" method="get">363 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">364 <input type="submit" value="Go">365 </form>366 </div>367 |368 </li>369 <li class="right">370<label class="theme-selector-label">371 Theme372 <select class="theme-selector" oninput="activateTheme(this.value)">373 <option value="auto" selected>Auto</option>374 <option value="light">Light</option>375 <option value="dark">Dark</option>376 </select>377</label> |</li>378 379 </ul>380 </div> 381 <div class="footer">382 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.383 <br>384 This page is licensed under the Python Software Foundation License Version 2.385 <br>386 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.387 <br>388 389 See <a href="/license.html">History and License</a> for more information.<br>390 391 392 <br>393 394 The Python Software Foundation is a non-profit corporation.395<a href="https://www.python.org/psf/donations/">Please donate.</a>396<br>397 <br>398 Last updated on Mar 10, 2026 (08:58 UTC).399 400 <a href="/bugs.html">Found a bug</a>?401 402 <br>403 404 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.405 </div>406 407 </body>408</html>