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, если True, выводит также тип по умолчанию.