19.1.1. email.message: Представление сообщения электронной почты¶email.message: Representing an email message

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

Центральный класс в пакете email – это класс Message, импортируемый из модуля email.message. Он служит базовым для объектной модели email. Message предоставляет основные средства для установки и чтения полей заголовков и доступа к телам сообщений.

Концептуально объект Message состоит из заголовков и полезных нагрузок. Заголовки представляют собой имена и значения полей в стиле RFC 2822, где имя и значение поля разделяются двоеточием. Двоеточие не является частью ни имени, ни значения поля.

Заголовки хранятся и возвращаются с сохранением регистра, но сравниваются без учёта регистра. Также может присутствовать одиночный конвертный заголовок, известный как заголовок Unix-From или заголовок From_. Полезная нагрузка – это либо строка для простых сообщений, либо список объектов Message для MIME-контейнеров (например, multipart/* и message/rfc822).

Объекты Message предоставляют интерфейс в стиле отображения для доступа к заголовкам сообщения, а также явный интерфейс для доступа как к заголовкам, так и к полезной нагрузке. Они предоставляют удобные методы для создания плоского текстового представления дерева объектов сообщения, для доступа к часто используемым параметрам заголовков и для рекурсивного обхода дерева объектов.

Ниже приведены методы класса Message:

class email.message.Message(policy=compat32)¶

Если указан параметр policy (он должен быть экземпляром класса policy), используйте заданные им правила для обновления и сериализации представления сообщения. Если policy не задан, используется политика compat32, которая обеспечивает обратную совместимость с версией Python 3.2 пакета email. Дополнительную информацию см. в документации policy.

Изменено в версии 3.3: Был добавлен именованный аргумент policy.

as_string(unixfrom=False, maxheaderlen=0, policy=None)¶

Возвращает всё сообщение, преобразованное в строку. Если необязательный параметр unixfrom имеет значение true, в возвращаемую строку включается конвертный заголовок. Значение unixfrom по умолчанию равно False. По причинам обратной совместимости maxheaderlen по умолчанию равен 0, поэтому если требуется другое значение, его необходимо указать явно (значение, указанное для max_line_length в политике, будет проигнорировано этим методом). Аргумент policy может быть использован для переопределения политики по умолчанию, полученной из экземпляра сообщения. Это можно использовать для управления некоторыми аспектами форматирования, которое выполняет метод, поскольку указанная policy будет передана в Generator.

Преобразование сообщения может вызвать изменения в Message, если необходимо заполнить значения по умолчанию для завершения преобразования в строку (например, могут быть созданы или изменены MIME-границы).

Обратите внимание, что этот метод предоставляется для удобства и может не всегда форматировать сообщение так, как вам нужно. Например, по умолчанию он не выполняет преобразование строк, начинающихся с From, которое требуется для формата unix mbox. Для большей гибкости создайте экземпляр Generator и используйте его метод flatten() напрямую. Например:

from io import StringIO
from email.generator import Generator
fp = StringIO()
g = Generator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()

Если объект сообщения содержит двоичные данные, которые не закодированы в соответствии со стандартами RFC, несоответствующие данные будут заменены на кодовые точки Unicode «неизвестный символ». (См. также as_bytes() и BytesGenerator.)

Изменено в версии 3.4: Добавлен именованный аргумент policy.

__str__()¶

Эквивалентно as_string(). Позволяет str(msg) создавать строку, содержащую отформатированное сообщение.

as_bytes(unixfrom=False, policy=None)¶

Возвращает всё сообщение, преобразованное в объект bytes. Если необязательный параметр unixfrom равен true, в возвращаемую строку включается конвертный заголовок. unixfrom по умолчанию равен False. Аргумент policy может использоваться для переопределения политики по умолчанию, полученной из экземпляра сообщения. Это может быть использовано для управления форматированием, создаваемым методом, поскольку указанная policy будет передана в BytesGenerator.

Преобразование сообщения может вызвать изменения в Message, если необходимо заполнить значения по умолчанию для завершения преобразования в строку (например, могут быть созданы или изменены MIME-границы).

Обратите внимание, что этот метод предоставляется для удобства и может не всегда форматировать сообщение так, как вам нужно. Например, по умолчанию он не выполняет преобразование строк, начинающихся с From, которое требуется для формата unix mbox. Для большей гибкости создайте экземпляр BytesGenerator и используйте его метод flatten() напрямую. Например:

from io import BytesIO
from email.generator import BytesGenerator
fp = BytesIO()
g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()

Новое в версии 3.4.

__bytes__()¶

Эквивалентно as_bytes(). Позволяет bytes(msg) создавать объект bytes, содержащий отформатированное сообщение.

Новое в версии 3.4.

is_multipart()¶

Возвращает True, если полезная нагрузка сообщения является списком дочерних объектов Message, в противном случае возвращает False. Когда is_multipart() возвращает False, полезная нагрузка должна быть строковым объектом. (Обратите внимание, что is_multipart(), возвращающий True, не обязательно означает, что «msg.get_content_maintype() == 'multipart'» вернёт True. Например, is_multipart вернёт True, когда Message имеет тип message/rfc822.)

set_unixfrom(unixfrom)¶

Устанавливает конвертный заголовок сообщения равным unixfrom, который должен быть строкой.

get_unixfrom()¶

Возвращает конвертный заголовок сообщения. По умолчанию равен None, если конвертный заголовок никогда не был установлен.

attach(payload)¶

Добавляет указанный payload к текущему payload, который до вызова должен быть None или списком объектов Message. После вызова payload всегда будет списком объектов Message. Если нужно установить payload в виде скалярного объекта (например, строки), используйте set_payload().

get_payload(i=None, decode=False)¶

Возвращает текущий payload: список объектов Message, если is_multipart() равно True, или строку, если is_multipart() равно False. Если payload является списком и вы изменяете его, вы изменяете payload сообщения на месте.

С необязательным аргументом i, get_payload() возвращает i-й элемент payload (нумерация с нуля), если is_multipart() равно True. Возникает IndexError, если i меньше 0 или больше или равно количеству элементов в payload. Если payload является строкой (т.е. is_multipart() равно False) и передан i, возникает TypeError.

Необязательный флаг decode указывает, нужно ли декодировать payload в соответствии с заголовком Content-Transfer-Encoding. Когда True и сообщение не является multipart, payload будет декодирован, если значение этого заголовка равно quoted-printable или base64. Если используется другая кодировка или заголовок Content-Transfer-Encoding отсутствует, payload возвращается как есть (без декодирования). Во всех случаях возвращаемые данные являются бинарными. Если сообщение multipart и флаг decode равен True, возвращается None. Если payload в формате base64 был сформирован некорректно (отсутствует дополнение, символы вне алфавита base64), в свойство defect сообщения добавляется соответствующий дефект (InvalidBase64PaddingDefect или InvalidBase64CharactersDefect соответственно).

Когда decode равен False (по умолчанию), тело возвращается в виде строки без декодирования Content-Transfer-Encoding. Однако для Content-Transfer-Encoding со значением 8bit предпринимается попытка декодировать исходные байты с использованием charset, указанной в заголовке Content-Type, с помощью обработчика ошибок replace. Если charset не указана или указанная charset не распознана пакетом email, тело декодируется с использованием кодировки ASCII по умолчанию.

set_payload(payload, charset=None)¶

Устанавливает payload всего объекта сообщения в payload. Ответственность за соблюдение инвариантов payload лежит на клиенте. Необязательный charset задаёт кодировку сообщения по умолчанию; подробнее см. set_charset().

set_charset(charset)¶

Устанавливает кодировку payload в charset, который может быть экземпляром Charset (см. email.charset), строкой с названием кодировки или None. Если это строка, она преобразуется в экземпляр Charset. Если charset равен None, параметр charset удаляется из заголовка Content-Type (сообщение больше не изменяется). Любое другое значение вызывает TypeError.

Если отсутствует заголовок MIME-Version, он будет добавлен. Если отсутствует заголовок Content-Type, он будет добавлен со значением text/plain. Независимо от того, существует ли заголовок Content-Type, его параметр charset будет установлен в charset.output_charset. Если charset.input_charset и charset.output_charset различаются, payload будет перекодирован в output_charset. Если отсутствует заголовок Content-Transfer-Encoding, payload будет закодирован для передачи при необходимости с использованием указанного Charset, и будет добавлен соответствующий заголовок. Если заголовок Content-Transfer-Encoding уже существует, считается, что payload уже корректно закодирован с использованием этого Content-Transfer-Encoding, и он не изменяется.

get_charset()¶

Возвращает экземпляр Charset, связанный с payload сообщения.

Следующие методы реализуют интерфейс, похожий на словарь, для доступа к заголовкам сообщения в формате RFC 2822. Обратите внимание на некоторые семантические отличия от обычного словаря. Например, в словаре нет дублирующихся ключей, а здесь могут быть повторяющиеся заголовки. Также в словарях нет гарантированного порядка ключей, возвращаемых keys(), а в объекте Message заголовки всегда возвращаются в том порядке, в котором они встречались в исходном сообщении или были добавлены позже. Любой удалённый и затем повторно добавленный заголовок всегда добавляется в конец списка заголовков.

Эти семантические различия являются намеренными и направлены на максимальное удобство.

Обратите внимание, что во всех случаях заголовки конверта, присутствующие в сообщении, не включаются в интерфейс отображения.

В модели, созданной из байтов, любые значения заголовков, которые (вопреки RFC) содержат не-ASCII байты, при получении через этот интерфейс будут представлены как объекты Header с кодировкой unknown-8bit.

__len__()¶

Возвращает общее количество заголовков, включая дубликаты.

__contains__(name)¶

Возвращает true, если объект сообщения имеет поле с именем name. Поиск выполняется без учёта регистра, и name не должен включать завершающее двоеточие. Используется для оператора in, например:

if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])

__getitem__(name)¶

Возвращает значение указанного поля заголовка. name не должен содержать разделитель-двоеточие. Если заголовок отсутствует, возвращается None; исключение KeyError никогда не возбуждается.

Обратите внимание: если указанное поле встречается в заголовках сообщения более одного раза, то не определено, какое именно из этих значений будет возвращено. Используйте метод get_all(), чтобы получить значения всех существующих заголовков с данным именем.

__setitem__(name, val)¶

Добавляет заголовок в сообщение с именем поля name и значением val. Поле добавляется в конец существующих полей сообщения.

Обратите внимание, что это не перезаписывает и не удаляет существующие заголовки с тем же именем. Если требуется гарантировать, что новый заголовок будет единственным в сообщении с именем поля name, сначала удалите это поле, например:

del msg['subject']
msg['subject'] = 'Python roolz!'

__delitem__(name)¶

Удаляет все вхождения поля с именем name из заголовков сообщения. Исключение не возбуждается, если указанное поле отсутствует в заголовках.

keys()¶

Возвращает список всех имён полей заголовков сообщения.

values()¶

Возвращает список всех значений полей сообщения.

items()¶

Возвращает список кортежей из двух элементов, содержащих все заголовки и значения полей сообщения.

get(name, failobj=None)¶

Возвращает значение указанного поля заголовка. Этот метод идентичен методу __getitem__() за исключением того, что если указанный заголовок отсутствует, возвращается необязательный параметр failobj (по умолчанию None).

Вот несколько дополнительных полезных методов:

get_all(name, failobj=None)¶

Возвращает список всех значений для поля с именем name. Если в сообщении нет таких заголовков, возвращается failobj (по умолчанию None).

add_header(_name, _value, **_params)¶

Расширенная настройка заголовка. Этот метод похож на __setitem__(), за исключением того, что дополнительные параметры заголовка можно передавать в виде именованных аргументов. _name – это добавляемое поле заголовка, а _value – основное значение заголовка.

Для каждого элемента в словаре именованных аргументов _params ключ воспринимается как имя параметра, при этом символы подчеркивания заменяются на дефисы (поскольку дефисы недопустимы в идентификаторах Python). Обычно параметр добавляется как key="value", если только значение не равно None, в этом случае будет добавлен только ключ. Если значение содержит не-ASCII символы, его можно указать в виде кортежа из трех элементов в формате (CHARSET, LANGUAGE, VALUE), где CHARSET – строка, задающая кодировку для кодирования значения, LANGUAGE обычно может быть установлен в None или пустую строку (см. RFC 2231 для других возможностей), а VALUE – строковое значение, содержащее не-ASCII кодовые точки. Если кортеж из трех элементов не передан и значение содержит не-ASCII символы, оно автоматически кодируется в формат RFC 2231 с использованием CHARSET равного utf-8 и LANGUAGE равного None.

Вот пример:

msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')

Это добавит заголовок, который выглядит как

Content-Disposition: attachment; filename="bud.gif"

Пример с не-ASCII символами:

msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '', 'Fußballer.ppt'))

Что даёт

Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"

replace_header(_name, _value)¶

Заменяет заголовок. Заменяет первый заголовок в сообщении, который совпадает с _name, сохраняя порядок заголовков и регистр имени поля. Если подходящий заголовок не найден, возбуждается KeyError.

get_content_type()¶

Возвращает тип содержимого сообщения. Возвращаемая строка приводится к нижнему регистру в форме maintype/subtype. Если в сообщении не было заголовка Content-Type, будет возвращен тип по умолчанию, заданный get_default_type(). Поскольку согласно RFC 2045 сообщения всегда имеют тип по умолчанию, get_content_type() всегда возвращает значение.

RFC 2045 определяет тип по умолчанию сообщения как text/plain, если только оно не находится внутри контейнера multipart/digest, в этом случае он будет message/rfc822. Если заголовок Content-Type содержит недопустимую спецификацию типа, RFC 2045 предписывает, что типом по умолчанию должен быть text/plain.

get_content_maintype()¶

Возвращает основной тип содержимого сообщения. Это часть maintype строки, возвращаемой get_content_type().

get_content_subtype()¶

Возвращает подтип содержимого сообщения. Это часть subtype строки, возвращаемой get_content_type().

get_default_type()¶

Возвращает тип содержимого по умолчанию. Большинство сообщений имеют тип содержимого по умолчанию text/plain, за исключением сообщений, которые являются подчастями контейнеров multipart/digest. Такие подчасти имеют тип содержимого по умолчанию message/rfc822.

set_default_type(ctype)¶

Устанавливает тип содержимого по умолчанию. ctype должен быть либо text/plain, либо message/rfc822, хотя это не принудительно. Тип содержимого по умолчанию не хранится в заголовке Content-Type.

get_params(failobj=None, header='content-type', unquote=True)¶

Возвращает параметры заголовка Content-Type сообщения в виде списка. Элементы возвращаемого списка – кортежи из двух элементов (ключ/значение), разделённые знаком '='. Левая часть от '=' – ключ, а правая – значение. Если в параметре нет знака '=', значением является пустая строка; в противном случае значение соответствует get_param() и не экранируется, если необязательный параметр unquote равен True (по умолчанию).

Необязательный параметр failobj – объект, возвращаемый при отсутствии заголовка Content-Type. Необязательный параметр header – заголовок, который нужно искать вместо Content-Type.

get_param(param, failobj=None, header='content-type', unquote=True)¶

Возвращает значение параметра param заголовка Content-Type в виде строки. Если сообщение не содержит заголовка Content-Type или такого параметра нет, возвращается failobj (по умолчанию None).

Необязательный параметр header, если указан, задаёт заголовок сообщения, который следует использовать вместо Content-Type.

Ключи параметров всегда сравниваются без учёта регистра. Возвращаемое значение может быть строкой или кортежем из трёх элементов, если параметр был закодирован по RFC 2231. Если это кортеж из трёх элементов, элементы значения имеют вид (CHARSET, LANGUAGE, VALUE). Обратите внимание, что и CHARSET, и LANGUAGE могут быть None; в этом случае следует считать, что VALUE закодирован в кодировке us-ascii. Обычно LANGUAGE можно игнорировать.

Если вашему приложению безразлично, был ли параметр закодирован по RFC 2231, можно свернуть значение параметра, вызвав email.utils.collapse_rfc2231_value() и передав возвращаемое значение из get_param(). Это вернёт подходящим образом декодированную строку Unicode, если значение является кортежем, или исходную строку без кавычек, если нет. Например:

rawparam = msg.get_param('foo')
param = email.utils.collapse_rfc2231_value(rawparam)

В любом случае значение параметра (возвращённая строка или элемент VALUE кортежа из трёх элементов) всегда не экранируется, если только unquote не установлен в False.

set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)¶

Устанавливает параметр в заголовке Content-Type. Если параметр уже существует в заголовке, его значение будет заменено на value. Если заголовок Content-Type ещё не задан для этого сообщения, он будет установлен в text/plain, а новое значение параметра будет добавлено в соответствии с RFC 2045.

Необязательный параметр header задаёт альтернативный заголовок для Content-Type; все параметры будут экранированы при необходимости, если только необязательный параметр requote не равен False (по умолчанию True).

Если указан необязательный параметр charset, параметр будет закодирован в соответствии с RFC 2231. Необязательный параметр language задаёт язык по RFC 2231, по умолчанию – пустая строка. И charset, и language должны быть строками.

Если replace равен False (по умолчанию), заголовок перемещается в конец списка заголовков. Если replace равен True, заголовок будет обновлён на месте.

Изменено в версии 3.4: replace добавлен ключевой параметр.

del_param(param, header='content-type', requote=True)¶

Полностью удаляет указанный параметр из заголовка Content-Type. Заголовок будет перезаписан на месте без параметра и его значения. Все значения будут экранированы при необходимости, если только requote не равен False (по умолчанию True). Необязательный параметр header задаёт альтернативу заголовку Content-Type.

set_type(type, header='Content-Type', requote=True)¶

Устанавливает основной тип и подтип для заголовка Content-Type. type должен быть строкой вида maintype/subtype, в противном случае возбуждается ValueError.

Этот метод заменяет заголовок Content-Type, сохраняя все параметры на месте. Если requote равен False, экранирование существующего заголовка остаётся без изменений; в противном случае параметры будут экранированы (по умолчанию).

Альтернативный заголовок можно указать в аргументе header. При установке заголовка Content-Type также добавляется заголовок MIME-Version.

get_filename(failobj=None)¶

Возвращает значение параметра filename заголовка Content-Disposition сообщения. Если в заголовке нет параметра filename, этот метод пытается найти параметр name в заголовке Content-Type. Если ни один из них не найден или заголовок отсутствует, возвращается failobj. Возвращаемая строка всегда будет раскрыта в соответствии с email.utils.unquote().

get_boundary(failobj=None)¶

Возвращает значение параметра boundary заголовка Content-Type сообщения или failobj, если заголовок отсутствует или не содержит параметра boundary. Возвращаемая строка всегда будет раскрыта в соответствии с email.utils.unquote().

set_boundary(boundary)¶

Устанавливает параметр boundary заголовка Content-Type в значение boundary. set_boundary() всегда будет заключать boundary в кавычки при необходимости. Возбуждается исключение HeaderParseError, если объект сообщения не имеет заголовка Content-Type.

Обратите внимание, что использование этого метода незначительно отличается от удаления старого заголовка Content-Type и добавления нового с новым boundary через add_header(), поскольку set_boundary() сохраняет порядок заголовка Content-Type в списке заголовков. Однако он не сохраняет строки продолжения, которые могли быть в исходном заголовке Content-Type.

get_content_charset(failobj=None)¶

Возвращает параметр charset заголовка Content-Type, приведённый к нижнему регистру. Если заголовок Content-Type отсутствует или не содержит параметра charset, возвращается failobj.

Обратите внимание, что этот метод отличается от get_charset(), который возвращает экземпляр Charset для кодировки тела сообщения по умолчанию.

get_charsets(failobj=None)¶

Возвращает список, содержащий имена наборов символов в сообщении. Если сообщение является multipart, список будет содержать по одному элементу для каждой вложенной части в полезной нагрузке; в противном случае это будет список длиной 1.

Каждый элемент списка будет строкой, которая является значением параметра charset в заголовке Content-Type для представленной вложенной части. Однако если у вложенной части нет заголовка Content-Type, нет параметра charset, или она не относится к основному MIME-типу text, то такой элемент списка будет равен failobj.

get_content_disposition()¶

Возвращает значение заголовка Content-Disposition сообщения в нижнем регистре (без параметров), если он есть, или None. Возможные значения этого метода: inline, attachment или None, если сообщение соответствует RFC 2183.

Новое в версии 3.5.

walk()¶

Метод walk() – это универсальный генератор, который можно использовать для обхода всех частей и подчастей дерева объекта сообщения в порядке прямого обхода в глубину. Обычно walk() используется как итератор в цикле for; каждая итерация возвращает следующую подчасть.

Вот пример, который выводит MIME-тип каждой части многокомпонентной структуры сообщения:

>>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain

walk обходит подчасти любой части, для которой is_multipart() возвращает True, даже если msg.get_content_maintype() == 'multipart' может возвращать False. Это видно в нашем примере при использовании отладочной вспомогательной функции _structure:

>>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain

Здесь части message не являются multiparts, но содержат подчасти. is_multipart() возвращает True, а walk спускается в подчасти.

Объекты Message также могут опционально содержать два атрибута экземпляра, которые можно использовать при создании обычного текста MIME-сообщения.

preamble¶

Формат MIME-документа допускает наличие некоторого текста между пустой строкой после заголовков и первой строкой границы multipart. Обычно этот текст не виден в MIME-совместимом почтовом клиенте, поскольку он находится вне стандартной MIME-защиты. Однако при просмотре необработанного текста сообщения или при просмотре сообщения в клиенте, не поддерживающем MIME, этот текст может стать видимым.

Атрибут preamble содержит этот дополнительный текст за пределами MIME-защиты для MIME-документов. Когда Parser обнаруживает некоторый текст после заголовков, но до первой строки границы, он присваивает этот текст атрибуту preamble сообщения. Когда Generator записывает текстовое представление MIME-сообщения и обнаруживает, что сообщение имеет атрибут preamble, он записывает этот текст в области между заголовками и первой границей. Подробнее см. email.parser и email.generator.

Обратите внимание: если у объекта сообщения нет преамбулы, атрибут preamble будет равен None.

epilogue¶

Атрибут epilogue действует так же, как атрибут preamble, за исключением того, что он содержит текст, который появляется между последней границей и концом сообщения.

Нет необходимости устанавливать epilogue в пустую строку, чтобы Generator выводил символ новой строки в конце файла.

defects¶

Атрибут defects содержит список всех проблем, обнаруженных при разборе этого сообщения. См. email.errors для подробного описания возможных дефектов разбора.