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 соответствующим образом.

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

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

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