email.encoders: Кодировщики

Исходный код: Lib/email/encoders.py

Этот модуль является частью устаревшего (Compat32) API для работы с электронной почтой. В новом API функциональность предоставляется параметром cte метода set_content().

Остальной текст в этом разделе — это оригинальная документация модуля.

При создании объектов Message с нуля вам часто требуется закодировать данные полезной нагрузки для передачи через совместимые почтовые серверы. Это особенно важно для сообщений типа image/* и text/*, содержащих двоичные данные.

Пакет email предоставляет несколько удобных кодировок в своем модуле encoders. Эти кодировщики фактически используются конструкторами классов MIMEAudio и MIMEImage для предоставления стандартных кодировок. Все функции кодировщиков принимают ровно один аргумент — объект сообщения для кодирования. Они обычно извлекают полезную нагрузку, кодируют её и сбрасывают полезную нагрузку на это новое закодированное значение. Они также должны устанавливать заголовок Content-Transfer-Encoding соответствующим образом.

Обратите внимание, что эти функции не имеют смысла для составного сообщения. Их необходимо применять к отдельным подчастям, а также они вызовут исключение TypeError, если в качестве аргумента передано сообщение типа multipart.

Вот предоставляемые функции кодирования:

email.encoders.encode_quopri(msg)

Кодирует полезную нагрузку в форме quoted-printable и устанавливает заголовок 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() также кодирует все символы табуляции и пробелы в данных.