Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
关注 1
点赞 0
百科 捐赠
gooderp18绿色标准版
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
分支: master
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/email.contentmanager.html

518 行
40KB
原始文件 永久链接 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="email.contentmanager: Managing MIME Content" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/email/contentmanager.py Content Manager Instances: Currently the email package provides only one concrete content manager, raw_data_manager, although more may be added in the futur..." />

  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/email/contentmanager.py Content Manager Instances: Currently the email package provides only one concrete content manager, raw_data_manager, although more may be added in the futur..." />

  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>email.contentmanager: Managing MIME Content &#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="email: Examples" href="email.examples.html" />

  39.     <link rel="prev" title="email.headerregistry: Custom Header Objects" href="email.headerregistry.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/email.contentmanager.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">email.contentmanager</span></code>: Managing MIME Content</a><ul>

  99. <li><a class="reference internal" href="#content-manager-instances">Content Manager Instances</a></li>

  100. </ul>

  101. </li>

  102. </ul>

  103. 

  104.   </div>

  105.   <div>

  106.     <h4>Previous topic</h4>

  107.     <p class="topless"><a href="email.headerregistry.html"

  108.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.headerregistry</span></code>: Custom Header Objects</a></p>

  109.   </div>

  110.   <div>

  111.     <h4>Next topic</h4>

  112.     <p class="topless"><a href="email.examples.html"

  113.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code>: Examples</a></p>

  114.   </div>

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

  116.     <h3>This Page</h3>

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

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

  119.       <li>

  120.         <a href="https://github.com/python/cpython/blob/main/Doc/library/email.contentmanager.rst"

  121.             rel="nofollow">Show Source

  122.         </a>

  123.       </li>

  124.     </ul>

  125.   </div>

  126.         </nav>

  127.     </div>

  128. </div>

  129. 

  130.   

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

  132.       <h3>Navigation</h3>

  133.       <ul>

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

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

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

  137.         <li class="right" >

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

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

  140.         <li class="right" >

  141.           <a href="email.examples.html" title="email: Examples"

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

  143.         <li class="right" >

  144.           <a href="email.headerregistry.html" title="email.headerregistry: Custom Header Objects"

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

  146. 

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

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

  149.           <li class="switchers">

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

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

  152.           </li>

  153.           <li>

  154.               

  155.           </li>

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

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

  158.     </li>

  159. 

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

  161.           <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> &#187;</li>

  162.           <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> &#187;</li>

  163.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.contentmanager</span></code>: Managing MIME Content</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-email.contentmanager">

  194. <span id="email-contentmanager-managing-mime-content"></span><h1><a class="reference internal" href="#module-email.contentmanager" title="email.contentmanager: Storing and Retrieving Content from MIME Parts"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.contentmanager</span></code></a>: Managing MIME Content<a class="headerlink" href="#module-email.contentmanager" 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/email/contentmanager.py">Lib/email/contentmanager.py</a></p>

  196. <hr class="docutils" />

  197. <div class="versionadded">

  198. <p><span class="versionmodified added">New in version 3.6: </span><a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p>

  199. </div>

  200. <dl class="py class">

  201. <dt class="sig sig-object py" id="email.contentmanager.ContentManager">

  202. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">ContentManager</span></span><a class="headerlink" href="#email.contentmanager.ContentManager" title="Link to this definition">¶</a></dt>

  203. <dd><p>Base class for content managers.  Provides the standard registry mechanisms

  204. to register converters between MIME content and other representations, as

  205. well as the <code class="docutils literal notranslate"><span class="pre">get_content</span></code> and <code class="docutils literal notranslate"><span class="pre">set_content</span></code> dispatch methods.</p>

  206. <dl class="py method">

  207. <dt class="sig sig-object py" id="email.contentmanager.ContentManager.get_content">

  208. <span class="sig-name descname"><span class="pre">get_content</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="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.ContentManager.get_content" title="Link to this definition">¶</a></dt>

  209. <dd><p>Look up a handler function based on the <code class="docutils literal notranslate"><span class="pre">mimetype</span></code> of <em>msg</em> (see next

  210. paragraph), call it, passing through all arguments, and return the result

  211. of the call.  The expectation is that the handler will extract the

  212. payload from <em>msg</em> and return an object that encodes information about

  213. the extracted data.</p>

  214. <p>To find the handler, look for the following keys in the registry,

  215. stopping with the first one found:</p>

  216. <ul class="simple">

  217. <li><p>the string representing the full MIME type (<code class="docutils literal notranslate"><span class="pre">maintype/subtype</span></code>)</p></li>

  218. <li><p>the string representing the <code class="docutils literal notranslate"><span class="pre">maintype</span></code></p></li>

  219. <li><p>the empty string</p></li>

  220. </ul>

  221. <p>If none of these keys produce a handler, raise a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> for the

  222. full MIME type.</p>

  223. </dd></dl>

  224. 

  225. <dl class="py method">

  226. <dt class="sig sig-object py" id="email.contentmanager.ContentManager.set_content">

  227. <span class="sig-name descname"><span class="pre">set_content</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">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.ContentManager.set_content" title="Link to this definition">¶</a></dt>

  228. <dd><p>If the <code class="docutils literal notranslate"><span class="pre">maintype</span></code> is <code class="docutils literal notranslate"><span class="pre">multipart</span></code>, raise a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>; otherwise

  229. look up a handler function based on the type of <em>obj</em> (see next

  230. paragraph), call <a class="reference internal" href="email.message.html#email.message.EmailMessage.clear_content" title="email.message.EmailMessage.clear_content"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clear_content()</span></code></a> on the

  231. <em>msg</em>, and call the handler function, passing through all arguments.  The

  232. expectation is that the handler will transform and store <em>obj</em> into

  233. <em>msg</em>, possibly making other changes to <em>msg</em> as well, such as adding

  234. various MIME headers to encode information needed to interpret the stored

  235. data.</p>

  236. <p>To find the handler, obtain the type of <em>obj</em> (<code class="docutils literal notranslate"><span class="pre">typ</span> <span class="pre">=</span> <span class="pre">type(obj)</span></code>), and

  237. look for the following keys in the registry, stopping with the first one

  238. found:</p>

  239. <ul class="simple">

  240. <li><p>the type itself (<code class="docutils literal notranslate"><span class="pre">typ</span></code>)</p></li>

  241. <li><p>the type’s fully qualified name (<code class="docutils literal notranslate"><span class="pre">typ.__module__</span> <span class="pre">+</span> <span class="pre">'.'</span> <span class="pre">+</span>

  242. <span class="pre">typ.__qualname__</span></code>).</p></li>

  243. <li><p>the type’s qualname (<code class="docutils literal notranslate"><span class="pre">typ.__qualname__</span></code>)</p></li>

  244. <li><p>the type’s name (<code class="docutils literal notranslate"><span class="pre">typ.__name__</span></code>).</p></li>

  245. </ul>

  246. <p>If none of the above match, repeat all of the checks above for each of

  247. the types in the <a class="reference internal" href="../glossary.html#term-MRO"><span class="xref std std-term">MRO</span></a> (<code class="docutils literal notranslate"><span class="pre">typ.__mro__</span></code>).  Finally, if no other key

  248. yields a handler, check for a handler for the key <code class="docutils literal notranslate"><span class="pre">None</span></code>.  If there is

  249. no handler for <code class="docutils literal notranslate"><span class="pre">None</span></code>, raise a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> for the fully

  250. qualified name of the type.</p>

  251. <p>Also add a <em class="mailheader">MIME-Version</em> header if one is not present (see

  252. also <a class="reference internal" href="email.message.html#email.message.MIMEPart" title="email.message.MIMEPart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEPart</span></code></a>).</p>

  253. </dd></dl>

  254. 

  255. <dl class="py method">

  256. <dt class="sig sig-object py" id="email.contentmanager.ContentManager.add_get_handler">

  257. <span class="sig-name descname"><span class="pre">add_get_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.ContentManager.add_get_handler" title="Link to this definition">¶</a></dt>

  258. <dd><p>Record the function <em>handler</em> as the handler for <em>key</em>.  For the possible

  259. values of <em>key</em>, see <a class="reference internal" href="#email.contentmanager.get_content" title="email.contentmanager.get_content"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_content()</span></code></a>.</p>

  260. </dd></dl>

  261. 

  262. <dl class="py method">

  263. <dt class="sig sig-object py" id="email.contentmanager.ContentManager.add_set_handler">

  264. <span class="sig-name descname"><span class="pre">add_set_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typekey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.ContentManager.add_set_handler" title="Link to this definition">¶</a></dt>

  265. <dd><p>Record <em>handler</em> as the function to call when an object of a type

  266. matching <em>typekey</em> is passed to <a class="reference internal" href="#email.contentmanager.set_content" title="email.contentmanager.set_content"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_content()</span></code></a>.  For the possible

  267. values of <em>typekey</em>, see <a class="reference internal" href="#email.contentmanager.set_content" title="email.contentmanager.set_content"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_content()</span></code></a>.</p>

  268. </dd></dl>

  269. 

  270. </dd></dl>

  271. 

  272. <section id="content-manager-instances">

  273. <h2>Content Manager Instances<a class="headerlink" href="#content-manager-instances" title="Link to this heading">¶</a></h2>

  274. <p>Currently the email package provides only one concrete content manager,

  275. <a class="reference internal" href="#email.contentmanager.raw_data_manager" title="email.contentmanager.raw_data_manager"><code class="xref py py-data docutils literal notranslate"><span class="pre">raw_data_manager</span></code></a>, although more may be added in the future.

  276. <a class="reference internal" href="#email.contentmanager.raw_data_manager" title="email.contentmanager.raw_data_manager"><code class="xref py py-data docutils literal notranslate"><span class="pre">raw_data_manager</span></code></a> is the

  277. <a class="reference internal" href="email.policy.html#email.policy.EmailPolicy.content_manager" title="email.policy.EmailPolicy.content_manager"><code class="xref py py-attr docutils literal notranslate"><span class="pre">content_manager</span></code></a> provided by

  278. <a class="reference internal" href="email.policy.html#email.policy.EmailPolicy" title="email.policy.EmailPolicy"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EmailPolicy</span></code></a> and its derivatives.</p>

  279. <dl class="py data">

  280. <dt class="sig sig-object py" id="email.contentmanager.raw_data_manager">

  281. <span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">raw_data_manager</span></span><a class="headerlink" href="#email.contentmanager.raw_data_manager" title="Link to this definition">¶</a></dt>

  282. <dd><p>This content manager provides only a minimum interface beyond that provided

  283. by <a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> itself:  it deals only with text, raw

  284. byte strings, and <a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> objects.  Nevertheless, it

  285. provides significant advantages compared to the base API: <code class="docutils literal notranslate"><span class="pre">get_content</span></code> on

  286. a text part will return a unicode string without the application needing to

  287. manually decode it, <code class="docutils literal notranslate"><span class="pre">set_content</span></code> provides a rich set of options for

  288. controlling the headers added to a part and controlling the content transfer

  289. encoding, and it enables the use of the various <code class="docutils literal notranslate"><span class="pre">add_</span></code> methods, thereby

  290. simplifying the creation of multipart messages.</p>

  291. <dl class="py method">

  292. <dt class="sig sig-object py" id="email.contentmanager.get_content">

  293. <span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">get_content</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">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'replace'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.get_content" title="Link to this definition">¶</a></dt>

  294. <dd><p>Return the payload of the part as either a string (for <code class="docutils literal notranslate"><span class="pre">text</span></code> parts), an

  295. <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">EmailMessage</span></code></a> object (for <code class="docutils literal notranslate"><span class="pre">message/rfc822</span></code>

  296. parts), or a <code class="docutils literal notranslate"><span class="pre">bytes</span></code> object (for all other non-multipart types).  Raise

  297. a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if called on a <code class="docutils literal notranslate"><span class="pre">multipart</span></code>.  If the part is a

  298. <code class="docutils literal notranslate"><span class="pre">text</span></code> part and <em>errors</em> is specified, use it as the error handler when

  299. decoding the payload to unicode.  The default error handler is

  300. <code class="docutils literal notranslate"><span class="pre">replace</span></code>.</p>

  301. </dd></dl>

  302. 

  303. <dl class="py method">

  304. <dt class="sig sig-object py" id="email.contentmanager.set_content">

  305. <span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">set_content</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">&lt;'str'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtype=&quot;plain&quot;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset='utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cte=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disposition=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cid=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.contentmanager.set_content" title="Link to this definition">¶</a></dt>

  306. <dt class="sig sig-object py">

  307. <span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">set_content</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">&lt;'bytes'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maintype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cte=&quot;base64&quot;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disposition=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cid=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers=None</span></span></em><span class="sig-paren">)</span></dt>

  308. <dt class="sig sig-object py">

  309. <span class="sig-prename descclassname"><span class="pre">email.contentmanager.</span></span><span class="sig-name descname"><span class="pre">set_content</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">&lt;'EmailMessage'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cte=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disposition=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cid=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers=None</span></span></em><span class="sig-paren">)</span></dt>

  310. <dd><p>Add headers and payload to <em>msg</em>:</p>

  311. <p>Add a <em class="mailheader">Content-Type</em> header with a <code class="docutils literal notranslate"><span class="pre">maintype/subtype</span></code>

  312. value.</p>

  313. <ul class="simple">

  314. <li><p>For <code class="docutils literal notranslate"><span class="pre">str</span></code>, set the MIME <code class="docutils literal notranslate"><span class="pre">maintype</span></code> to <code class="docutils literal notranslate"><span class="pre">text</span></code>, and set the

  315. subtype to <em>subtype</em> if it is specified, or <code class="docutils literal notranslate"><span class="pre">plain</span></code> if it is not.</p></li>

  316. <li><p>For <code class="docutils literal notranslate"><span class="pre">bytes</span></code>, use the specified <em>maintype</em> and <em>subtype</em>, or

  317. raise a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> if they are not specified.</p></li>

  318. <li><p>For <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">EmailMessage</span></code></a> objects, set the maintype

  319. to <code class="docutils literal notranslate"><span class="pre">message</span></code>, and set the subtype to <em>subtype</em> if it is

  320. specified or <code class="docutils literal notranslate"><span class="pre">rfc822</span></code> if it is not.  If <em>subtype</em> is

  321. <code class="docutils literal notranslate"><span class="pre">partial</span></code>, raise an error (<code class="docutils literal notranslate"><span class="pre">bytes</span></code> objects must be used to

  322. construct <code class="docutils literal notranslate"><span class="pre">message/partial</span></code> parts).</p></li>

  323. </ul>

  324. <p>If <em>charset</em> is provided (which is valid only for <code class="docutils literal notranslate"><span class="pre">str</span></code>), encode the

  325. string to bytes using the specified character set.  The default is

  326. <code class="docutils literal notranslate"><span class="pre">utf-8</span></code>.  If the specified <em>charset</em> is a known alias for a standard

  327. MIME charset name, use the standard charset instead.</p>

  328. <p>If <em>cte</em> is set, encode the payload using the specified content transfer

  329. encoding, and set the <em class="mailheader">Content-Transfer-Encoding</em> header to

  330. that value.  Possible values for <em>cte</em> are <code class="docutils literal notranslate"><span class="pre">quoted-printable</span></code>,

  331. <code class="docutils literal notranslate"><span class="pre">base64</span></code>, <code class="docutils literal notranslate"><span class="pre">7bit</span></code>, <code class="docutils literal notranslate"><span class="pre">8bit</span></code>, and <code class="docutils literal notranslate"><span class="pre">binary</span></code>.  If the input cannot be

  332. encoded in the specified encoding (for example, specifying a <em>cte</em> of

  333. <code class="docutils literal notranslate"><span class="pre">7bit</span></code> for an input that contains non-ASCII values), raise a

  334. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  335. <ul class="simple">

  336. <li><p>For <code class="docutils literal notranslate"><span class="pre">str</span></code> objects, if <em>cte</em> is not set use heuristics to

  337. determine the most compact encoding.</p></li>

  338. <li><p>For <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">EmailMessage</span></code></a>, per <span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2046.html"><strong>RFC 2046</strong></a>, raise

  339. an error if a <em>cte</em> of <code class="docutils literal notranslate"><span class="pre">quoted-printable</span></code> or <code class="docutils literal notranslate"><span class="pre">base64</span></code> is

  340. requested for <em>subtype</em> <code class="docutils literal notranslate"><span class="pre">rfc822</span></code>, and for any <em>cte</em> other than

  341. <code class="docutils literal notranslate"><span class="pre">7bit</span></code> for <em>subtype</em> <code class="docutils literal notranslate"><span class="pre">external-body</span></code>.  For

  342. <code class="docutils literal notranslate"><span class="pre">message/rfc822</span></code>, use <code class="docutils literal notranslate"><span class="pre">8bit</span></code> if <em>cte</em> is not specified.  For

  343. all other values of <em>subtype</em>, use <code class="docutils literal notranslate"><span class="pre">7bit</span></code>.</p></li>

  344. </ul>

  345. <div class="admonition note">

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

  347. <p>A <em>cte</em> of <code class="docutils literal notranslate"><span class="pre">binary</span></code> does not actually work correctly yet.

  348. The <code class="docutils literal notranslate"><span class="pre">EmailMessage</span></code> object as modified by <code class="docutils literal notranslate"><span class="pre">set_content</span></code> is

  349. correct, but <a class="reference internal" href="email.generator.html#email.generator.BytesGenerator" title="email.generator.BytesGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">BytesGenerator</span></code></a> does not

  350. serialize it correctly.</p>

  351. </div>

  352. <p>If <em>disposition</em> is set, use it as the value of the

  353. <em class="mailheader">Content-Disposition</em> header.  If not specified, and

  354. <em>filename</em> is specified, add the header with the value <code class="docutils literal notranslate"><span class="pre">attachment</span></code>.

  355. If <em>disposition</em> is not specified and <em>filename</em> is also not specified,

  356. do not add the header.  The only valid values for <em>disposition</em> are

  357. <code class="docutils literal notranslate"><span class="pre">attachment</span></code> and <code class="docutils literal notranslate"><span class="pre">inline</span></code>.</p>

  358. <p>If <em>filename</em> is specified, use it as the value of the <code class="docutils literal notranslate"><span class="pre">filename</span></code>

  359. parameter of the <em class="mailheader">Content-Disposition</em> header.</p>

  360. <p>If <em>cid</em> is specified, add a <em class="mailheader">Content-ID</em> header with

  361. <em>cid</em> as its value.</p>

  362. <p>If <em>params</em> is specified, iterate its <code class="docutils literal notranslate"><span class="pre">items</span></code> method and use the

  363. resulting <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pairs to set additional parameters on the

  364. <em class="mailheader">Content-Type</em> header.</p>

  365. <p>If <em>headers</em> is specified and is a list of strings of the form

  366. <code class="docutils literal notranslate"><span class="pre">headername:</span> <span class="pre">headervalue</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">header</span></code> objects

  367. (distinguished from strings by having a <code class="docutils literal notranslate"><span class="pre">name</span></code> attribute), add the

  368. headers to <em>msg</em>.</p>

  369. </dd></dl>

  370. 

  371. </dd></dl>

  372. 

  373. <p class="rubric">Footnotes</p>

  374. <aside class="footnote-list brackets">

  375. <aside class="footnote brackets" id="id2" role="doc-footnote">

  376. <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>

  377. <p>Originally added in 3.4 as a <a class="reference internal" href="../glossary.html#term-provisional-package"><span class="xref std std-term">provisional module</span></a></p>

  378. </aside>

  379. </aside>

  380. </section>

  381. </section>

  382. 

  383. 

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

  385.           </div>

  386.         </div>

  387.       </div>

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

  389.         <div class="sphinxsidebarwrapper">

  390.   <div>

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

  392.     <ul>

  393. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.contentmanager</span></code>: Managing MIME Content</a><ul>

  394. <li><a class="reference internal" href="#content-manager-instances">Content Manager Instances</a></li>

  395. </ul>

  396. </li>

  397. </ul>

  398. 

  399.   </div>

  400.   <div>

  401.     <h4>Previous topic</h4>

  402.     <p class="topless"><a href="email.headerregistry.html"

  403.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.headerregistry</span></code>: Custom Header Objects</a></p>

  404.   </div>

  405.   <div>

  406.     <h4>Next topic</h4>

  407.     <p class="topless"><a href="email.examples.html"

  408.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code>: Examples</a></p>

  409.   </div>

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

  411.     <h3>This Page</h3>

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

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

  414.       <li>

  415.         <a href="https://github.com/python/cpython/blob/main/Doc/library/email.contentmanager.rst"

  416.             rel="nofollow">Show Source

  417.         </a>

  418.       </li>

  419.     </ul>

  420.   </div>

  421.         </div>

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

  423. <span>«</span>

  424. </div>

  425. 

  426.       </div>

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

  428.     </div>  

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

  430.       <h3>Navigation</h3>

  431.       <ul>

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

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

  434.              >index</a></li>

  435.         <li class="right" >

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

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

  438.         <li class="right" >

  439.           <a href="email.examples.html" title="email: Examples"

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

  441.         <li class="right" >

  442.           <a href="email.headerregistry.html" title="email.headerregistry: Custom Header Objects"

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

  444. 

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

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

  447.           <li class="switchers">

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

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

  450.           </li>

  451.           <li>

  452.               

  453.           </li>

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

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

  456.     </li>

  457. 

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

  459.           <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> &#187;</li>

  460.           <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> &#187;</li>

  461.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.contentmanager</span></code>: Managing MIME Content</a></li>

  462.                 <li class="right">

  463.                     

  464. 

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

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

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

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

  469.         </form>

  470.     </div>

  471.                      |

  472.                 </li>

  473.             <li class="right">

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

  475.     Theme

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

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

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

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

  480.     </select>

  481. </label> |</li>

  482.             

  483.       </ul>

  484.     </div>  

  485.     <div class="footer">

  486.     &copy; 

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

  488.     

  489.     Copyright

  490.     

  491.       </a>

  492.      2001-2024, Python Software Foundation.

  493.     <br />

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

  495.     <br />

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

  497.     <br />

  498.     

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

  500.     

  501.     

  502.     <br />

  503. 

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

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

  506. <br />

  507.     <br />

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

  509.     

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

  511.     

  512.     <br />

  513. 

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

  515.     </div>

  516. 

  517.   </body>

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