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

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

В настоящее время пакет электронной почты предоставляет только один конкретный менеджер содержимого, 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.

Примечания