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_ методы, упрощая создание сообщений multipart.

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

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

Примечания