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

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

Этот модуль является частью устаревшего (Compat32) API для email. В новом 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.

Примечания