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

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

class email.contentmanager.ContentManager

Базовый класс для менеджеров содержимого. Предоставляет стандартные механизмы регистрации преобразователей между содержимым MIME и другими представлениями, а также методы get_content и set_content диспетчеризации.

get_content(msg, *args, **kw)

Ищет функцию-обработчик на основе mimetype объекта msg (см. следующий абзац), вызывает её, передавая все аргументы, и возвращает результат вызова. Ожидается, что обработчик извлечёт полезную нагрузку из msg и вернёт объект, кодирующий информацию об извлечённых данных.

Для поиска обработчика ищутся следующие ключи в реестре, останавливаясь на первом найденном:

• строка, представляющая полное MIME-тип (maintype/subtype)
• строка, представляющая maintype
• пустая строка

Если ни один из этих ключей не приводит к обработчику, вызывается исключение KeyError для полного MIME-типа.

set_content(msg, obj, *args, **kw)

Если maintype имеет значение multipart, вызывается исключение TypeError; в противном случае ищется функция-обработчик на основе типа obj (см. следующий абзац), вызывается clear_content() для msg, и вызывается функция-обработчик, передавая все аргументы. Ожидается, что обработчик преобразует и сохранит obj в msg, возможно, внеся и другие изменения в msg, например, добавив различные заголовки MIME для кодирования информации, необходимой для интерпретации сохранённых данных.

Для поиска обработчика берётся тип obj (typ = type(obj)), и ищутся следующие ключи в реестре, останавливаясь на первом найденном:

• сам тип (typ)
• полное имя типа (typ.__module__ + '.' + typ.__qualname__).
• qualname типа (typ.__qualname__)
• имя типа (typ.__name__).

Если ничего не найдено, повторяются все проверки для каждого типа в MRO (typ.__mro__). Наконец, если обработчик не найден, проверяется наличие обработчика для ключа None. Если обработчик для None не найден, вызывается исключение KeyError для полного имени типа.

Также добавляется заголовок MIME-Version, если он отсутствует (см. также MIMEPart).

add_get_handler(key, handler)

Записывает функцию handler как обработчик для key. Возможные значения key см. в get_content().

add_set_handler(typekey, handler)

Записывает handler как функцию для вызова, когда объект соответствующего типа typekey передаётся в set_content(). Возможные значения typekey см. в set_content().

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

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