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