# `email.encoders`: 编码器

源代码: Lib/email/encoders.py

此模块是旧版 (`Compat32`) email API 的组成部分。 在新版 API 中将由 `set_content()` 方法的 cte 形参提供该功能。

This module is deprecated in Python 3. The functions provided here should not be called explicitly since the `MIMEText` class sets the content type and CTE header using the _subtype and _charset values passed during the instantiation of that class.

本段落中的剩余文本是该模块的原始文档。

当创建全新的 `Message` 对象时，你经常需要对载荷编码以便通过兼容的邮件服务器进行传输。 对于包含二进制数据的 image/* 和 text/* 类型的消息来说尤其如此。

`email` 包在其 `encoders` 模块中提供了一些方便的编码器。 这些编码器实际上由 `MIMEAudio` 和 `MIMEImage` 类构造器所使用以提供默认编码格式。 所有编码器函数都只接受一个参数，即要编码的消息对象。 它们通常会提取有效载荷，对其进行编码，并将载荷重置为这种新编码的值。 它们还应当相应地设置 Content-Transfer-Encoding 标头。

请注意，这些函数对于多段消息没有意义。 它们必须应用到各个单独的段上面，而不是整体。如果直接传递一个多段类型的消息，会产生一个 `TypeError` 错误。

下面是提供的编码函数：

`email.encoders.``encode_quopri`(msg)

  将有效数据编码为经转换的可打印形式，并将 Content-Transfer-Encoding 标头设置为 `quoted-printable` 1。 当大多数实际的数据是普通的可打印数据但包含少量不可打印的字符时，这是一个很好的编码。

`email.encoders.``encode_base64`(msg)

  将有效载荷编码为 base64 形式，并将 Content-Transfer-Encoding 标头设为 `base64`。 当你的载荷主要包含不可打印数据时这是一种很好用的编码格式，因为它比 quoted-printable 更紧凑。 base64 编码格式的缺点是它会使文本变成人类不可读的形式。

`email.encoders.``encode_7or8bit`(msg)

  此函数并不实际改变消息的有效载荷，但它会基于载荷数据将 Content-Transfer-Encoding 标头相应地设为 `7bit` 或 `8bit`。

`email.encoders.``encode_noop`(msg)

  此函数什么都不会做；它甚至不会设置 Content-Transfer-Encoding 标头。

脚注

1

  请注意使用 `encode_quopri()` 编码格式还会对数据中的所有制表符和空格符进行编码。