email.iterators: Итераторы

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

Перебирать дерево объектов сообщения с помощью метода Message.walk довольно просто. Модуль email.iterators предоставляет несколько полезных итераторов более высокого уровня для работы с деревьями объектов сообщений.

email.iterators.body_line_iterator(msg, decode=False)

Этот итератор проходит по всем полезным нагрузкам во всех вложенных частях msg и возвращает строковые полезные нагрузки построчно. Он пропускает заголовки всех вложенных частей, а также любые вложенные части, полезная нагрузка которых не является строкой Python. Это примерно эквивалентно чтению текстового представления сообщения в плоском виде из файла с помощью readline() с пропуском всех промежуточных заголовков.

Необязательный аргумент decode передаётся методу Message.get_payload.

email.iterators.typed_subpart_iterator(msg, maintype='text', subtype=None)

Этот итератор проходит по всем вложенным частям msg и возвращает только те из них, которые соответствуют типу MIME, заданному аргументами maintype и subtype.

Обратите внимание, что аргумент subtype необязателен; если он не указан, соответствие типа MIME вложенной части проверяется только по основному типу. Аргумент maintype также необязателен; по умолчанию используется text.

Таким образом, по умолчанию typed_subpart_iterator() возвращает каждую вложенную часть с типом MIME text/*.

Следующая функция добавлена как полезное средство отладки. Её не следует считать частью поддерживаемого публичного интерфейса пакета.

email.iterators._structure(msg, fp=None, level=0, include_default=False)

Выводит с отступами представление типов содержимого в структуре объекта сообщения. Например:

>>> msg = email.message_from_file(somefile)
>>> _structure(msg)
multipart/mixed
    text/plain
    text/plain
    multipart/digest
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
    text/plain

Необязательный аргумент fp — это файловый объект, в который выводятся данные. Он должен быть совместим с функцией Python print(). Аргумент level используется внутри функции. Если значение include_default истинно, выводится также тип по умолчанию.