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

Примеры менеджеров содержимого

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

email.contentmanager.raw_data_manager

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

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

Возвращает полезную нагрузку части в виде строки (для text частей), объекта EmailMessage (для message/rfc822 частей) или объекта bytes (для всех других типов, не являющихся составными). Вызывает исключение KeyError, если вызвана на multipart. Если часть является text частью и задан errors, используйте его как обработчик ошибок при декодировании полезной нагрузки в Юникод. По умолчанию используется обработчик ошибок 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 как временный модуль