klarkxy/hustoj
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
31c676fc3a90da202967121f3a2008a26155a7b7
hustoj/web/python-docs/library/email.mime.html
klarkxy 723430cade 增加python文档
2025-03-09 17:10:56 +08:00

362 lines
39 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="zh_CN">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>email.mime: 从头创建电子邮件和 MIME 对象 &#8212; Python 3.8.20 文档</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/translations.js"></script>
<script src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="在 Python 3.8.20 文档 中搜索"
href="../_static/opensearch.xml"/>
<link rel="author" title="关于这些文档" href="../about.html" />
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="copyright" title="版权所有" href="../copyright.html" />
<link rel="next" title="email.header: 国际化标头" href="email.header.html" />
<link rel="prev" title="email.message.Message: 使用 compat32 API 来表示电子邮件消息" href="email.compat32-message.html" />
<link rel="canonical" href="https://docs.python.org/3/library/email.mime.html" />
<style>
@media only screen {
table.full-width-table {
width: 100%;
}
}
</style>
<link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript" src="../_static/menu.js"></script>
</head>
<body>
<div class="mobile-nav">
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
<label for="menuToggler" class="toggler__label">
<span></span>
</label>
<nav class="nav-content" role="navigation">
<a href="https://www.python.org/" class="nav-logo">
<img src="../_static/py.svg" alt="Logo"/>
</a>
<div class="version_switcher_placeholder"></div>
<form role="search" class="search" action="../search.html" method="get">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
<path fill-rule="nonzero"
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" fill="#444"></path>
</svg>
<input type="text" name="q" aria-label="快速搜索"/>
<input type="submit" value="转向"/>
</form>
</nav>
<div class="menu-wrapper">
<nav class="menu" role="navigation" aria-label="main navigation">
<div class="language_switcher_placeholder"></div>
<h4>上一个主题</h4>
<p class="topless"><a href="email.compat32-message.html"
title="上一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.message.Message</span></code>: 使用 <code class="xref py py-data docutils literal notranslate"><span class="pre">compat32</span></code> API 来表示电子邮件消息</a></p>
<h4>下一个主题</h4>
<p class="topless"><a href="email.header.html"
title="下一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.header</span></code>: 国际化标头</a></p>
<div role="note" aria-label="source link">
<h3>本页</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">报告 Bug</a></li>
<li>
<a href="https://github.com/python/cpython/blob/3.8/Doc/library/email.mime.rst"
rel="nofollow">显示源代码
</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
这个文档所针对的是一个已不再受支持的 Python 旧版本。
你应当升级版本，并阅读
<a href="/3/library/email.mime.html"> Python 当前稳定版本的文档</a>.
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>导航</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="总目录"
accesskey="I">索引</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python 模块索引"
>模块</a> |</li>
<li class="right" >
<a href="email.header.html" title="email.header: 国际化标头"
accesskey="N">下一页</a> |</li>
<li class="right" >
<a href="email.compat32-message.html" title="email.message.Message: 使用 compat32 API 来表示电子邮件消息"
accesskey="P">上一页</a> |</li>
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
</li>
<li id="cpython-language-and-version">
<a href="../index.html">3.8.20 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="index.html" >Python 标准库</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="netdata.html" >互联网数据处理</a> &#187;</li>
<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> --- 电子邮件与 MIME 处理包</a> &#187;</li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="快速搜索" aria-label="快速搜索" type="text" name="q" />
<input type="submit" value="转向" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-email.mime">
<span id="email-mime-creating-email-and-mime-objects-from-scratch"></span><h1><a class="reference internal" href="#module-email.mime" title="email.mime: Build MIME messages."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime</span></code></a>: 从头创建电子邮件和 MIME 对象<a class="headerlink" href="#module-email.mime" title="永久链接至标题"></a></h1>
<p><strong>源代码:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.8/Lib/email/mime/">Lib/email/mime/</a></p>
<hr class="docutils" />
<p>此模块是旧版 (<code class="docutils literal notranslate"><span class="pre">Compat32</span></code>) 电子邮件 API 的组成部分。 它的功能在新版 API 中被 <a class="reference internal" href="email.contentmanager.html#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">contentmanager</span></code></a> 部分替代，但在某些应用中这些类仍可能有用，即使是在非旧版代码中。</p>
<p>通常，你是通过传递一个文件或一些文本到解析器来获得消息对象结构体的，解析器会解析文本并返回根消息对象。 不过你也可以从头开始构建一个完整的消息结构体，甚至是手动构建单独的 <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> 对象。 实际上，你也可以接受一个现有的结构体并添加新的 <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> 对象并移动它们。 这为切片和分割 MIME 消息提供了非常方便的接口。</p>
<p>你可以通过创建 <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> 实例并手动添加附件和所有适当的标头来创建一个新的对象结构体。 不过对于 MIME 消息来说，<a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code></a> 包提供了一些便捷子类来让事情变得更容易。</p>
<p>这些类列示如下:</p>
<dl class="class">
<dt id="email.mime.base.MIMEBase">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.base.</code><code class="sig-name descname">MIMEBase</code><span class="sig-paren">(</span><em class="sig-param">_maintype</em>, <em class="sig-param">_subtype</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em>, <em class="sig-param">**_params</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.base.MIMEBase" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.base</span></code></p>
<p>这是 <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> 的所有 MIME 专属子类。 通常你不会创建专门的 <a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 实例，尽管你可以这样做。 <a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 主要被提供用来作为更具体的 MIME 感知子类的便捷基类。</p>
<p><em>_maintype</em> 是 <em class="mailheader">Content-Type</em> 的主类型 (例如 <em class="mimetype">text</em> 或 <em class="mimetype">image</em>)，而 <em>_subtype</em> 是 <em class="mailheader">Content-Type</em> 的次类型 (例如 <em class="mimetype">plain</em> 或 <em class="mimetype">gif</em>)。 <em>_params</em> 是一个形参键/值字典并会被直接传递给 <a class="reference internal" href="email.compat32-message.html#email.message.Message.add_header" title="email.message.Message.add_header"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.add_header</span></code></a>。</p>
<p>如果指定了 <em>policy</em> (默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a> 策略)，它将被传递给 <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>。</p>
<p><a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 类总是会添加一个 <em class="mailheader">Content-Type</em> 标头 (基于 <em>_maintype</em>, <em>_subtype</em> 和 <em>_params</em>)，以及一个 <em class="mailheader">MIME-Version</em> 标头 (总是设为 <code class="docutils literal notranslate"><span class="pre">1.0</span></code>)。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.nonmultipart.MIMENonMultipart">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.nonmultipart.</code><code class="sig-name descname">MIMENonMultipart</code><a class="headerlink" href="#email.mime.nonmultipart.MIMENonMultipart" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.nonmultipart</span></code></p>
<p><a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 的子类，这是用于非 <em class="mimetype">multipart</em> MIME 消息的中间基类。 这个类的主要目标是避免使用 <a class="reference internal" href="email.compat32-message.html#email.message.Message.attach" title="email.message.Message.attach"><code class="xref py py-meth docutils literal notranslate"><span class="pre">attach()</span></code></a> 方法，该方法仅对 <em class="mimetype">multipart</em> 消息有意义。 如果 <a class="reference internal" href="email.compat32-message.html#email.message.Message.attach" title="email.message.Message.attach"><code class="xref py py-meth docutils literal notranslate"><span class="pre">attach()</span></code></a> 被调用，则会引发 <a class="reference internal" href="email.errors.html#email.errors.MultipartConversionError" title="email.errors.MultipartConversionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">MultipartConversionError</span></code></a> 异常。</p>
</dd></dl>
<dl class="class">
<dt id="email.mime.multipart.MIMEMultipart">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.multipart.</code><code class="sig-name descname">MIMEMultipart</code><span class="sig-paren">(</span><em class="sig-param">_subtype='mixed'</em>, <em class="sig-param">boundary=None</em>, <em class="sig-param">_subparts=None</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em>, <em class="sig-param">**_params</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.multipart.MIMEMultipart" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.multipart</span></code></p>
<p><a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 的子类，这是用于 <em class="mimetype">multipart</em> MIME 消息的中间基类。 可选的 <em>_subtype</em> 默认为 <em class="mimetype">mixed</em>，但可被用来指定消息的子类型。 将会在消息对象中添加一个 <em class="mimetype">multipart/_subtype</em> 的 <em class="mailheader">Content-Type</em> 标头。 并还将添加一个 <em class="mailheader">MIME-Version</em> 标头。</p>
<p>可选的 <em>boundary</em> 是多部分边界字符串。 当为 <code class="docutils literal notranslate"><span class="pre">None</span></code> (默认值) 时，则会在必要时（例如当消息被序列化时）计算边界。</p>
<p><em>_subparts</em> 是载荷初始子部分的序列。 此序列必须可以被转换为列表。 你总是可以使用 <a class="reference internal" href="email.compat32-message.html#email.message.Message.attach" title="email.message.Message.attach"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.attach</span></code></a> 方法将新的子部分附加到消息中。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<p>用于 <em class="mailheader">Content-Type</em> 标头的附加形参会从关键字参数中获取，或者传入到 <em>_params</em> 参数，该参数是一个关键字的字典。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.application.MIMEApplication">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.application.</code><code class="sig-name descname">MIMEApplication</code><span class="sig-paren">(</span><em class="sig-param">_data</em>, <em class="sig-param">_subtype='octet-stream'</em>, <em class="sig-param">_encoder=email.encoders.encode_base64</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em>, <em class="sig-param">**_params</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.application.MIMEApplication" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.application</span></code></p>
<p><a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 的子类，<a class="reference internal" href="#email.mime.application.MIMEApplication" title="email.mime.application.MIMEApplication"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEApplication</span></code></a> 类被用来表示主类型为 <em class="mimetype">application</em> 的 MIME 消息。 <em>_data</em> 是包含原始字节数据的字符串。 可选的 <em>_subtype</em> 指定 MIME 子类型并默认为 <em class="mimetype">octet-stream</em>。</p>
<p>可选的 <em>_encoder</em> 是一个可调用对象（即函数），它将执行实际的数据编码以便传输。 这个可调用对象接受一个参数，该参数是 <a class="reference internal" href="#email.mime.application.MIMEApplication" title="email.mime.application.MIMEApplication"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEApplication</span></code></a> 的实例。 它应当使用 <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">get_payload()</span></code></a> 和 <a class="reference internal" href="email.compat32-message.html#email.message.Message.set_payload" title="email.message.Message.set_payload"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_payload()</span></code></a> 来将载荷改为已编码形式。 它还应根据需要将任何 <em class="mailheader">Content-Transfer-Encoding</em> 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 <a class="reference internal" href="email.encoders.html#module-email.encoders" title="email.encoders: Encoders for email message payloads."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.encoders</span></code></a> 模块来查看内置编码器列表。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<p><em>_params</em> 会被直接传递给基类的构造器。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.audio.MIMEAudio">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.audio.</code><code class="sig-name descname">MIMEAudio</code><span class="sig-paren">(</span><em class="sig-param">_audiodata</em>, <em class="sig-param">_subtype=None</em>, <em class="sig-param">_encoder=email.encoders.encode_base64</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em>, <em class="sig-param">**_params</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.audio.MIMEAudio" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.audio</span></code></p>
<p><a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 的子类，<a class="reference internal" href="#email.mime.audio.MIMEAudio" title="email.mime.audio.MIMEAudio"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEAudio</span></code></a> 类被用来创建主类型为 <em class="mimetype">audio</em> 的 MIME 消息。 <em>_audiodata</em> 是包含原始音频数据的字符串。 如果此数据可由标准 Python 模块 <a class="reference internal" href="sndhdr.html#module-sndhdr" title="sndhdr: Determine type of a sound file."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sndhdr</span></code></a> 来解码，则其子类型将被自动包括在 <em class="mailheader">Content-Type</em> 标头中。 在其他情况下你可以通过 <em>_subtype</em> 参数显式地指定音频子类型 。 如果无法猜测出主类型并且未给出 <em>_subtype</em>，则会引发 <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>。</p>
<p>可选的 <em>_encoder</em> 是一个可调用对象（即函数），它将执行实际的音频数据编码以便传输。 这个可调用对象接受一个参数，该参数是 <a class="reference internal" href="#email.mime.audio.MIMEAudio" title="email.mime.audio.MIMEAudio"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEAudio</span></code></a> 的实例。 它应当使用 <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">get_payload()</span></code></a> 和 <a class="reference internal" href="email.compat32-message.html#email.message.Message.set_payload" title="email.message.Message.set_payload"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_payload()</span></code></a> 来将载荷改为已编码形式。 它还应根据需要将任何 <em class="mailheader">Content-Transfer-Encoding</em> 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 <a class="reference internal" href="email.encoders.html#module-email.encoders" title="email.encoders: Encoders for email message payloads."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.encoders</span></code></a> 模块来查看内置编码器列表。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<p><em>_params</em> 会被直接传递给基类的构造器。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.image.MIMEImage">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.image.</code><code class="sig-name descname">MIMEImage</code><span class="sig-paren">(</span><em class="sig-param">_imagedata</em>, <em class="sig-param">_subtype=None</em>, <em class="sig-param">_encoder=email.encoders.encode_base64</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em>, <em class="sig-param">**_params</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.image.MIMEImage" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.image</span></code></p>
<p><a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 的子类，<a class="reference internal" href="#email.mime.image.MIMEImage" title="email.mime.image.MIMEImage"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEImage</span></code></a> 类被用来创建主类型为 <em class="mimetype">image</em> 的 MIME 消息对象。 <em>_imagedata</em> 是包含原始图像数据的字符串。 如果此数据可由标准 Python 模块 <a class="reference internal" href="imghdr.html#module-imghdr" title="imghdr: Determine the type of image contained in a file or byte stream."><code class="xref py py-mod docutils literal notranslate"><span class="pre">imghdr</span></code></a> 来解码，则其子类型将被自动包括在 <em class="mailheader">Content-Type</em> 标头中。 在其他情况下你可以通过 <em>_subtype</em> 参数显式地指定图像子类型。 如果无法猜测出主类型并且未给出 <em>_subtype</em>，则会引发 <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>。</p>
<p>可选的 <em>_encoder</em> 是一个可调用对象（即函数），它将执行实际的图像数据编码以便传输。 这个可调用对象接受一个参数，该参数是 <a class="reference internal" href="#email.mime.image.MIMEImage" title="email.mime.image.MIMEImage"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEImage</span></code></a> 的实例。 它应当使用 <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">get_payload()</span></code></a> 和 <a class="reference internal" href="email.compat32-message.html#email.message.Message.set_payload" title="email.message.Message.set_payload"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_payload()</span></code></a> 来将载荷改为已编码形式。 它还应根据需要将任何 <em class="mailheader">Content-Transfer-Encoding</em> 或其他标头添加到消息对象中。 默认编码格式为 base64。 请参阅 <a class="reference internal" href="email.encoders.html#module-email.encoders" title="email.encoders: Encoders for email message payloads."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.encoders</span></code></a> 模块来查看内置编码器列表。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<p><em>_params</em> 会被直接传递给 <a class="reference internal" href="#email.mime.base.MIMEBase" title="email.mime.base.MIMEBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEBase</span></code></a> 构造器。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.message.MIMEMessage">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.message.</code><code class="sig-name descname">MIMEMessage</code><span class="sig-paren">(</span><em class="sig-param">_msg</em>, <em class="sig-param">_subtype='rfc822'</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.message.MIMEMessage" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.message</span></code></p>
<p><a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 的子类，<a class="reference internal" href="#email.mime.message.MIMEMessage" title="email.mime.message.MIMEMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEMessage</span></code></a> 类被用来创建主类型为 <em class="mimetype">message</em> 的 MIME 对象。 <em>_msg</em> 将被用作载荷，并且必须为 <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> 类（或其子类）的实例，否则会引发 <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>。</p>
<p>可选的 <em>_subtype</em> 设置消息的子类型；它的默认值为 <em class="mimetype">rfc822</em>。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
<dl class="class">
<dt id="email.mime.text.MIMEText">
<em class="property">class </em><code class="sig-prename descclassname">email.mime.text.</code><code class="sig-name descname">MIMEText</code><span class="sig-paren">(</span><em class="sig-param">_text</em>, <em class="sig-param">_subtype='plain'</em>, <em class="sig-param">_charset=None</em>, <em class="sig-param">*</em>, <em class="sig-param">policy=compat32</em><span class="sig-paren">)</span><a class="headerlink" href="#email.mime.text.MIMEText" title="永久链接至目标"></a></dt>
<dd><p>模块: <code class="xref py py-mod docutils literal notranslate"><span class="pre">email.mime.text</span></code></p>
<p><a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 的子类，<a class="reference internal" href="#email.mime.text.MIMEText" title="email.mime.text.MIMEText"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMEText</span></code></a> 类被用来创建主类型为 <em class="mimetype">text</em> 的 MIME 对象。 <em>_text</em> 是用作载荷的字符串。 <em>_subtype</em> 指定子类型并且默认为 <em class="mimetype">plain</em>。 <em>_charset</em> 是文本的字符集并会作为参数传递给 <a class="reference internal" href="#email.mime.nonmultipart.MIMENonMultipart" title="email.mime.nonmultipart.MIMENonMultipart"><code class="xref py py-class docutils literal notranslate"><span class="pre">MIMENonMultipart</span></code></a> 构造器；如果该字符串仅包含 <code class="docutils literal notranslate"><span class="pre">ascii</span></code> 码位则其默认值为 <code class="docutils literal notranslate"><span class="pre">us-ascii</span></code>，否则为 <code class="docutils literal notranslate"><span class="pre">utf-8</span></code>。 <em>_charset</em> 形参接受一个字符串或是一个 <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Charset</span></code></a> 实例。</p>
<p>除非 <em>_charset</em> 参数被显式地设为 <code class="docutils literal notranslate"><span class="pre">None</span></code>，否则所创建的 MIMEText 对象将同时具有附带 <code class="docutils literal notranslate"><span class="pre">charset</span></code> 形参的 <em class="mailheader">Content-Type</em> 标头，以及 <em class="mailheader">Content-Transfer-Encoding</em> 标头。 这意味着后续的 <code class="docutils literal notranslate"><span class="pre">set_payload</span></code> 调用将不再产生已编码的载荷，即使它在 <code class="docutils literal notranslate"><span class="pre">set_payload</span></code> 命令中被传入。 你可以通过删除 <code class="docutils literal notranslate"><span class="pre">Content-Transfer-Encoding</span></code> 标头来“重置”此行为，在此之后的 <code class="docutils literal notranslate"><span class="pre">set_payload</span></code> 调用将自动编码新的载荷（并添加新的 <em class="mailheader">Content-Transfer-Encoding</em> 标头）。</p>
<p>可选的 <em>policy</em> 参数默认为 <a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate"><span class="pre">compat32</span></code></a>。</p>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.5 版更改: </span><em>_charset</em> 也可接受 <a class="reference internal" href="email.charset.html#email.charset.Charset" title="email.charset.Charset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Charset</span></code></a> 实例。</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">在 3.6 版更改: </span>添加了 <em>policy</em> 仅限关键字形参。</p>
</div>
</dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>上一个主题</h4>
<p class="topless"><a href="email.compat32-message.html"
title="上一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.message.Message</span></code>: 使用 <code class="xref py py-data docutils literal notranslate"><span class="pre">compat32</span></code> API 来表示电子邮件消息</a></p>
<h4>下一个主题</h4>
<p class="topless"><a href="email.header.html"
title="下一章"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.header</span></code>: 国际化标头</a></p>
<div role="note" aria-label="source link">
<h3>本页</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">报告 Bug</a></li>
<li>
<a href="https://github.com/python/cpython/blob/3.8/Doc/library/email.mime.rst"
rel="nofollow">显示源代码
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>导航</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="总目录"
>索引</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python 模块索引"
>模块</a> |</li>
<li class="right" >
<a href="email.header.html" title="email.header: 国际化标头"
>下一页</a> |</li>
<li class="right" >
<a href="email.compat32-message.html" title="email.message.Message: 使用 compat32 API 来表示电子邮件消息"
>上一页</a> |</li>
<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
</li>
<li id="cpython-language-and-version">
<a href="../index.html">3.8.20 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="index.html" >Python 标准库</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="netdata.html" >互联网数据处理</a> &#187;</li>
<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> --- 电子邮件与 MIME 处理包</a> &#187;</li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="快速搜索" aria-label="快速搜索" type="text" name="q" />
<input type="submit" value="转向" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
|
</li>
</ul>
</div>
<div class="footer">
&copy; <a href="../copyright.html">版权所有</a> 2001-2024, Python Software Foundation.
<br />
This page is licensed under the Python Software Foundation License Version 2.
<br />
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
<br />
<br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
<br />
最后更新于 12月 09, 2024.
<a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 2.4.4.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink