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

Источник: Lib/email/iterators.py

---

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

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

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

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