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 — это файловый объект, в который выводятся результаты. Он должен подходить для функции print() в Python. Аргумент level используется внутри функции. Если аргумент include_default имеет значение true, выводится также тип по умолчанию.