email.contentmanager: Управление содержимым MIME

Примеры Content Manager

В настоящее время пакет email предоставляет только один конкретный менеджер содержимого, raw_data_manager, хотя в будущем могут быть добавлены другие. raw_data_manager — это content_manager, предоставляемый EmailPolicy и его производными.

email.contentmanager.raw_data_manager

Этот менеджер содержимого предоставляет только минимальный интерфейс, расширяющий возможности, предоставляемые самим Message: он работает только с текстом, сырыми байтовыми строками и объектами Message. Тем не менее, он обеспечивает существенные преимущества по сравнению с базовым API: get_content части текста вернёт строку Unicode без необходимости ручного декодирования приложением, set_content предоставляет богатый набор параметров для управления заголовками, добавляемыми к части, и управления кодировкой передачи содержимого, а также позволяет использовать различные add_ методы, тем самым упрощая создание составных сообщений.

email.contentmanager.get_content(msg, errors='replace')

Возвращает содержимое части в виде строки (для text частей), объекта EmailMessage (для message/rfc822 частей) или объекта bytes (для всех других типов, не являющихся составными). Вызывает KeyError, если вызов выполнен для multipart. Если часть является text частью и указан параметр errors, используйте его как обработчик ошибок при декодировании содержимого в Unicode. По умолчанию используется обработчик ошибок replace.

email.contentmanager.set_content(msg, <'str'>, subtype="plain", charset='utf-8', cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

email.contentmanager.set_content(msg, <'bytes'>, maintype, subtype, cte="base64", disposition=None, filename=None, cid=None, params=None, headers=None)

email.contentmanager.set_content(msg, <'EmailMessage'>, cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

Добавить заголовки и содержимое к msg:

Добавляет заголовок Content-Type со значением maintype/subtype.

• Для str, установите MIME maintype в text, и установите подтип в subtype, если он указан, или plain в противном случае.
• Для bytes, используйте указанные maintype и subtype, или вызовите TypeError, если они не указаны.
• Для объектов EmailMessage, установите maintype в message, и установите подтип в subtype, если он указан, или rfc822 в противном случае. Если subtype равен partial, вызовите ошибку (объекты bytes должны использоваться для построения message/partial частей).

Если указан charset (это допустимо только для str), закодируйте строку в байты, используя указанную кодировку символов. По умолчанию используется utf-8. Если указанный charset является известным псевдонимом стандартного имени кодировки MIME, используется стандартная кодировка.

Если задан cte, закодируйте содержимое с помощью указанной кодировки передачи содержимого и установите заголовок Content-Transfer-Encoding в это значение. Возможные значения для cte: quoted-printable, base64, 7bit, 8bit, и binary. Если входные данные невозможно закодировать в указанной кодировке (например, если задан cte 7bit для входных данных, содержащих символы, не являющиеся ASCII), вызывается ValueError.

• Для str объектов, если cte не задано, используйте эвристику для определения наиболее компактной кодировки.
• Для EmailMessage, согласно RFC 2046, вызывается ошибка, если запрос cte quoted-printable или base64 для subtype rfc822, и для любого cte, кроме 7bit для subtype external-body. Для message/rfc822, используется 8bit если cte не указано. Для всех остальных значений subtype используется 7bit.

Примечание

cte binary пока не работает корректно. Объект EmailMessage, изменённый с помощью set_content, верный, но BytesGenerator не сериализует его корректно.

Если задано disposition, используйте его как значение заголовка Content-Disposition. Если не задано, а filename указано, добавьте заголовок со значением attachment. Если disposition не указан и filename также не указан, заголовок не добавляется. Единственные допустимые значения для disposition — attachment и inline.

Если задано filename, используйте его как значение параметра filename заголовка Content-Disposition.

Если задано cid, добавьте заголовок Content-ID со значением cid.

Если задано params, выполните итерацию по методу items и используйте полученные пары (key, value) для установки дополнительных параметров в заголовке Content-Type.

Если задано headers и оно является списком строк вида headername: headervalue или списком объектов header (отличающихся от строк наличием атрибута name), добавьте заголовки в msg.

Примечания

1

Первоначально добавлен в 3.4 в качестве промежуточного модуля