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

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

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

Этот модуль устарел в Python 3. Функции, предоставляемые здесь, не должны вызываться явно, поскольку класс MIMEText устанавливает тип контента и заголовок CTE с использованием значений _subtype и _charset, переданных во время инициализации этого класса.

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

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

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

Обратите внимание, что эти функции не имеют смысла для сообщения типа multipart. Они должны применяться к отдельным подчастям, а не к всему сообщению, и вызовут 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() также кодирует все табуляции и пробелы в данных.