`email.compat32-message.md`

397 строк · 47.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/library/email.compat32-message.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message): представление email-сообщения с помощью API [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.compat32)89Класс [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) очень похож на класс [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage), но без методов, добавленных в этом классе, и с немного отличающимся поведением по умолчанию некоторых других методов. Здесь также описаны методы, которые, хотя и поддерживаются классом `EmailMessage`, не рекомендуются к использованию, кроме случаев работы с устаревшим кодом.1011В остальном философия и структура обоих классов одинаковы.1213В этом документе описывается поведение при использовании политики [`Compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32) по умолчанию (для [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message)). При использовании другой политики следует использовать класс [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage).1415An email message consists of *headers* and a *payload*. Headers must be [**RFC 5322**](https://python-all.ru/3/library/email.compat32-message.html) style names and values, where the field name and value are separated by a colon. The colon is not part of either the field name or the field value. The payload may be a simple text message, or a binary object, or a structured sequence of sub-messages each with their own set of headers and their own payload. The latter type of payload is indicated by the message having a MIME type such as *multipart/\** or *message/rfc822*.1617Концептуальная модель объекта [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) представляет собой упорядоченный словарь заголовков с дополнительными методами для доступа как к специализированной информации из заголовков, так и к полезной нагрузке, для генерации сериализованной версии сообщения и для рекурсивного обхода дерева объектов. Обратите внимание, что дублирующиеся заголовки поддерживаются, но для доступа к ним необходимо использовать специальные методы.1819Псевдословарь [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) индексируется по именам заголовков, которые должны быть значениями ASCII. Значения словаря – строки, которые должны содержать только символы ASCII; предусмотрена специальная обработка для входных данных, не являющихся ASCII, но она не всегда дает правильные результаты. Заголовки хранятся и возвращаются с сохранением регистра, но имена полей сопоставляются без учета регистра. Также может присутствовать единичный конвертный заголовок, также известный как заголовок *Unix-From* или заголовок `From_`. *Полезная нагрузка* представляет собой либо строку, либо байты в случае простых объектов сообщений, либо список объектов `Message` для документов-контейнеров MIME (например, *multipart/\** и *message/rfc822*).2021Ниже приведены методы класса [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message):2223#### `class email.message.Message(policy=compat32)`2425Если указан параметр *policy* (он должен быть экземпляром класса [`policy`](https://python-all.ru/3/library/email.policy.html#module-email.policy)), используйте заданные им правила для обновления и сериализации представления сообщения. Если *policy* не задан, используется политика [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32), которая обеспечивает обратную совместимость с версией Python 3.2 пакета email. Дополнительную информацию см. в документации `policy`.2627Изменено в версии 3.3: Был добавлен именованный аргумент *policy*.2829#### `as_string(unixfrom=False, maxheaderlen=0, policy=None)`3031Возвращает всё сообщение, преобразованное в строку. Если необязательный параметр *unixfrom* имеет значение true, в возвращаемую строку включается конвертный заголовок. Значение *unixfrom* по умолчанию равно `False`. По причинам обратной совместимости *maxheaderlen* по умолчанию равен `0`, поэтому если требуется другое значение, его необходимо указать явно (значение, указанное для *max\_line\_length* в политике, будет проигнорировано этим методом). Аргумент *policy* может быть использован для переопределения политики по умолчанию, полученной из экземпляра сообщения. Это можно использовать для управления некоторыми аспектами форматирования, которое выполняет метод, поскольку указанная *policy* будет передана в `Generator`.3233Преобразование сообщения в строку может вызвать изменения в `Message`, если необходимо заполнить значения по умолчанию для завершения преобразования в строку (например, могут быть созданы или изменены MIME-границы).3435Обратите внимание, что этот метод предоставляется для удобства и не всегда форматирует сообщение так, как требуется. Например, по умолчанию он не выполняет преобразование строк, начинающихся с `From`, которое требуется для формата Unix mbox. Для большей гибкости создайте экземпляр [`Generator`](https://python-all.ru/3/library/email.generator.html#email.generator.Generator) и используйте его метод [`flatten()`](https://python-all.ru/3/library/email.generator.html#email.generator.Generator.flatten) напрямую. Например:3637```python38from io import StringIO39from email.generator import Generator40fp = StringIO()41g = Generator(fp, mangle_from_=True, maxheaderlen=60)42g.flatten(msg)43text = fp.getvalue()44```4546Если объект сообщения содержит двоичные данные, которые не закодированы в соответствии со стандартами RFC, несоответствующие данные будут заменены на кодовые точки Unicode «неизвестный символ». (См. также [`as_bytes()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.as_bytes) и [`BytesGenerator`](https://python-all.ru/3/library/email.generator.html#email.generator.BytesGenerator).)4748Изменено в версии 3.4: Добавлен именованный аргумент *policy*.4950#### `__str__()`5152Эквивалентно [`as_string()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.as_string). Позволяет `str(msg)` создавать строку, содержащую отформатированное сообщение.5354#### `as_bytes(unixfrom=False, policy=None)`5556Возвращает всё сообщение, преобразованное в объект bytes. Если необязательный параметр *unixfrom* имеет значение true, в возвращаемую строку включается конвертный заголовок. *unixfrom* по умолчанию равен `False`. Аргумент *policy* может быть использован для переопределения политики по умолчанию, полученной из экземпляра сообщения. Это можно использовать для управления некоторыми аспектами форматирования, которое выполняет метод, поскольку указанная *policy* будет передана в `BytesGenerator`.5758Преобразование сообщения может вызвать изменения в `Message`, если необходимо заполнить значения по умолчанию для завершения преобразования в строку (например, могут быть созданы или изменены MIME-границы).5960Обратите внимание, что этот метод предоставляется для удобства и не всегда форматирует сообщение так, как требуется. Например, по умолчанию он не выполняет преобразование строк, начинающихся с `From`, которое требуется для формата Unix mbox. Для большей гибкости создайте экземпляр [`BytesGenerator`](https://python-all.ru/3/library/email.generator.html#email.generator.BytesGenerator) и используйте его метод [`flatten()`](https://python-all.ru/3/library/email.generator.html#email.generator.BytesGenerator.flatten) напрямую. Например:6162```python63from io import BytesIO64from email.generator import BytesGenerator65fp = BytesIO()66g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60)67g.flatten(msg)68text = fp.getvalue()69```7071Добавлено в версии 3.4.7273#### `__bytes__()`7475Эквивалентно [`as_bytes()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.as_bytes). Позволяет `bytes(msg)` создавать объект bytes, содержащий отформатированное сообщение.7677Добавлено в версии 3.4.7879#### `is_multipart()`8081Возвращает `True`, если полезная нагрузка сообщения является списком объектов `Message`, иначе возвращает `False`. Когда `is_multipart()` возвращает `False`, полезная нагрузка должна быть строковым объектом (который может быть двоичной полезной нагрузкой, закодированной с помощью CTE). (Обратите внимание, что возврат `True` методом `is_multipart()` не обязательно означает, что «msg.get\_content\_maintype() == 'multipart'» вернёт `True`. Например, `is_multipart` вернёт `True`, когда `Message` имеет тип `message/rfc822`.)8283#### `set_unixfrom(unixfrom)`8485Устанавливает конвертный заголовок сообщения равным *unixfrom*, который должен быть строкой.8687#### `get_unixfrom()`8889Return the message’s envelope header. Defaults to `None` if the envelope header was never set.9091#### `attach(payload)`9293Add the given *payload* to the current payload, which must be `None` or a list of `Message` objects before the call. After the call, the payload will always be a list of `Message` objects. If you want to set the payload to a scalar object (e.g. a string), use [`set_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.set_payload) instead.9495This is a legacy method. On the [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) class its functionality is replaced by [`set_content()`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage.set_content) and the related `make` and `add` methods.9697#### `get_payload(i=None, decode=False)`9899Return the current payload, which will be a list of `Message` objects when [`is_multipart()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.is_multipart) is `True`, or a string when `is_multipart()` is `False`. If the payload is a list and you mutate the list object, you modify the message’s payload in place.100101With optional argument *i*, `get_payload()` will return the *i*-th element of the payload, counting from zero, if [`is_multipart()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.is_multipart) is `True`. An [`IndexError`](https://python-all.ru/3/library/exceptions.html#IndexError) will be raised if *i* is less than 0 or greater than or equal to the number of items in the payload. If the payload is a string (i.e. `is_multipart()` is `False`) and *i* is given, a [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError) is raised.102103Optional *decode* is a flag indicating whether the payload should be decoded or not, according to the *Content-Transfer-Encoding* header. When `True` and the message is not a multipart, the payload will be decoded if this header’s value is `quoted-printable` or `base64`. If some other encoding is used, or *Content-Transfer-Encoding* header is missing, the payload is returned as-is (undecoded). In all cases the returned value is binary data. If the message is a multipart and the *decode* flag is `True`, then `None` is returned. If the payload is base64 and it was not perfectly formed (missing padding, characters outside the base64 alphabet), then an appropriate defect will be added to the message’s defect property ([`InvalidBase64PaddingDefect`](https://python-all.ru/3/library/email.errors.html#email.errors.InvalidBase64PaddingDefect) or [`InvalidBase64CharactersDefect`](https://python-all.ru/3/library/email.errors.html#email.errors.InvalidBase64CharactersDefect), respectively).104105When *decode* is `False` (the default) the body is returned as a string without decoding the *Content-Transfer-Encoding*. However, for a *Content-Transfer-Encoding* of 8bit, an attempt is made to decode the original bytes using the `charset` specified by the *Content-Type* header, using the `replace` error handler. If no `charset` is specified, or if the `charset` given is not recognized by the email package, the body is decoded using the default ASCII charset.106107This is a legacy method. On the [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) class its functionality is replaced by [`get_content()`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage.get_content) and [`iter_parts()`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage.iter_parts).108109#### `set_payload(payload, charset=None)`110111Set the entire message object’s payload to *payload*. It is the client’s responsibility to ensure the payload invariants. Optional *charset* sets the message’s default character set; see [`set_charset()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.set_charset) for details.112113This is a legacy method. On the [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) class its functionality is replaced by [`set_content()`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage.set_content).114115#### `set_charset(charset)`116117Set the character set of the payload to *charset*, which can either be a [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset) instance (see [`email.charset`](https://python-all.ru/3/library/email.charset.html#module-email.charset)), a string naming a character set, or `None`. If it is a string, it will be converted to a `Charset` instance. If *charset* is `None`, the `charset` parameter will be removed from the *Content-Type* header (the message will not be otherwise modified). Anything else will generate a [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError).118119If there is no existing *MIME-Version* header one will be added. If there is no existing *Content-Type* header, one will be added with a value of *text/plain*. Whether the *Content-Type* header already exists or not, its `charset` parameter will be set to *charset.output\_charset*. If *charset.input\_charset* and *charset.output\_charset* differ, the payload will be re-encoded to the *output\_charset*. If there is no existing *Content-Transfer-Encoding* header, then the payload will be transfer-encoded, if needed, using the specified [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset), and a header with the appropriate value will be added. If a *Content-Transfer-Encoding* header already exists, the payload is assumed to already be correctly encoded using that *Content-Transfer-Encoding* and is not modified.120121This is a legacy method. On the [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) class its functionality is replaced by the *charset* parameter of the [`email.message.EmailMessage.set_content()`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage.set_content) method.122123#### `get_charset()`124125Return the [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset) instance associated with the message’s payload.126127This is a legacy method. On the [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) class it always returns `None`.128129The following methods implement a mapping-like interface for accessing the message’s [**RFC 2822**](https://python-all.ru/3/library/email.compat32-message.html) headers. Note that there are some semantic differences between these methods and a normal mapping (i.e. dictionary) interface. For example, in a dictionary there are no duplicate keys, but here there may be duplicate message headers. Also, in dictionaries there is no guaranteed order to the keys returned by [`keys()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.keys), but in a `Message` object, headers are always returned in the order they appeared in the original message, or were added to the message later. Any header deleted and then re-added are always appended to the end of the header list.130131These semantic differences are intentional and are biased toward maximal convenience.132133Note that in all cases, any envelope header present in the message is not included in the mapping interface.134135In a model generated from bytes, any header values that (in contravention of the RFCs) contain non-ASCII bytes will, when retrieved through this interface, be represented as [`Header`](https://python-all.ru/3/library/email.header.html#email.header.Header) objects with a charset of `unknown-8bit`.136137#### `__len__()`138139Return the total number of headers, including duplicates.140141#### `__contains__(name)`142143Return `True` if the message object has a field named *name*. Matching is done case-insensitively and *name* should not include the trailing colon. Used for the `in` operator, e.g.:144145```python146if 'message-id' in myMessage:147   print('Message-ID:', myMessage['message-id'])148```149150#### `__getitem__(name)`151152Return the value of the named header field. *name* should not include the colon field separator. If the header is missing, `None` is returned; a [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError) is never raised.153154Note that if the named field appears more than once in the message’s headers, exactly which of those field values will be returned is undefined. Use the [`get_all()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_all) method to get the values of all the extant named headers.155156#### `__setitem__(name, val)`157158Добавляет заголовок в сообщение с именем поля *name* и значением *val*. Поле добавляется в конец существующих полей сообщения.159160Обратите внимание: этот метод *не* перезаписывает и не удаляет существующие заголовки с таким же именем. Если нужно гарантировать, что новый заголовок будет единственным в сообщении с именем поля *name*, сначала удалите поле, например:161162```python163del msg['subject']164msg['subject'] = 'Python roolz!'165```166167#### `__delitem__(name)`168169Удаляет все вхождения поля с именем *name* из заголовков сообщения. Исключение не возбуждается, если указанное поле отсутствует в заголовках.170171#### `keys()`172173Возвращает список всех имен полей заголовков сообщения.174175#### `values()`176177Возвращает список всех значений полей сообщения.178179#### `items()`180181Возвращает список кортежей из двух элементов, содержащих все заголовки и значения полей сообщения.182183#### `get(name, failobj=None)`184185Возвращает значение указанного поля заголовка. Этот метод идентичен методу [`__getitem__()`](https://python-all.ru/3/reference/datamodel.html#object.__getitem__) за исключением того, что если указанный заголовок отсутствует, возвращается необязательный параметр *failobj* (по умолчанию `None`).186187Вот несколько дополнительных полезных методов:188189#### `get_all(name, failobj=None)`190191Возвращает список всех значений для поля с именем *name*. Если в сообщении нет таких именованных заголовков, возвращается *failobj* (по умолчанию `None`).192193#### `add_header(_name, _value, **_params)`194195Расширенная установка заголовка. Этот метод похож на [`__setitem__()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.__setitem__), за исключением того, что дополнительные параметры заголовка могут быть переданы в качестве именованных аргументов. *\_name* – это добавляемое поле заголовка, а *\_value* – это *основное* значение заголовка.196197Для каждого элемента в словаре именованных аргументов *\_params* ключ воспринимается как имя параметра, при этом символы подчеркивания заменяются на дефисы (поскольку дефисы недопустимы в идентификаторах Python). Обычно параметр добавляется как `key="value"`, если только значение не равно `None`, в этом случае будет добавлен только ключ. Если значение содержит не-ASCII символы, его можно указать в виде кортежа из трех элементов в формате `(CHARSET, LANGUAGE, VALUE)`, где `CHARSET` – строка, задающая кодировку для кодирования значения, `LANGUAGE` обычно может быть установлен в `None` или пустую строку (см. [**RFC 2231**](https://python-all.ru/3/library/email.compat32-message.html) для других возможностей), а `VALUE` – строковое значение, содержащее не-ASCII кодовые точки. Если кортеж из трех элементов не передан и значение содержит не-ASCII символы, оно автоматически кодируется в формат [**RFC 2231**](https://python-all.ru/3/library/email.compat32-message.html) с использованием `CHARSET` равного `utf-8` и `LANGUAGE` равного `None`.198199Вот пример:200201```python202msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')203```204205Это добавит заголовок, который будет выглядеть как206207```python208Content-Disposition: attachment; filename="bud.gif"209```210211Пример с не-ASCII символами:212213```python214msg.add_header('Content-Disposition', 'attachment',215               filename=('iso-8859-1', '', 'Fußballer.ppt'))216```217218Что даёт219220```python221Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"222```223224#### `replace_header(_name, _value)`225226Заменяет заголовок. Заменяет первый заголовок в сообщении, который совпадает с *\_name*, сохраняя порядок заголовков и регистр имени поля. Если подходящий заголовок не найден, возбуждается [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError).227228#### `get_content_type()`229230Возвращает тип содержимого сообщения. Возвращаемая строка приводится к нижнему регистру в форме *maintype/subtype*. Если в сообщении не было заголовка *Content-Type*, будет возвращен тип по умолчанию, заданный [`get_default_type()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_default_type). Поскольку согласно [**RFC 2045**](https://python-all.ru/3/library/email.compat32-message.html) сообщения всегда имеют тип по умолчанию, `get_content_type()` всегда возвращает значение.231232[**RFC 2045**](https://python-all.ru/3/library/email.compat32-message.html) определяет тип по умолчанию сообщения как *text/plain*, если только оно не находится внутри контейнера *multipart/digest*, в этом случае он будет *message/rfc822*. Если заголовок *Content-Type* содержит недопустимую спецификацию типа, [**RFC 2045**](https://python-all.ru/3/library/email.compat32-message.html) предписывает, что типом по умолчанию должен быть *text/plain*.233234#### `get_content_maintype()`235236Возвращает основной тип содержимого сообщения. Это часть *maintype* строки, возвращаемой методом [`get_content_type()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_content_type).237238#### `get_content_subtype()`239240Возвращает подтип содержимого сообщения. Это часть *subtype* строки, возвращаемой методом [`get_content_type()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_content_type).241242#### `get_default_type()`243244Возвращает тип содержимого по умолчанию. У большинства сообщений тип содержимого по умолчанию – *text/plain*, за исключением сообщений, являющихся вложенными частями контейнеров *multipart/digest*. У таких вложенных частей тип содержимого по умолчанию – *message/rfc822*.245246#### `set_default_type(ctype)`247248Устанавливает тип содержимого по умолчанию. *ctype* должен быть либо *text/plain*, либо *message/rfc822*, хотя это не принудительно. Тип содержимого по умолчанию не хранится в заголовке *Content-Type*.249250#### `get_params(failobj=None, header='content-type', unquote=True)`251252Возвращает параметры заголовка *Content-Type* сообщения в виде списка. Элементы возвращаемого списка – кортежи из двух элементов (ключ/значение), разделённые знаком `'='`. Левая часть от `'='` – ключ, а правая – значение. Если в параметре нет знака `'='`, значением является пустая строка; в противном случае значение соответствует [`get_param()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_param) и не экранируется, если необязательный параметр *unquote* равен `True` (по умолчанию).253254Необязательный параметр *failobj* – объект, возвращаемый при отсутствии заголовка *Content-Type*. Необязательный параметр *header* – заголовок, который нужно искать вместо *Content-Type*.255256Это устаревший метод. В классе [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) его функциональность заменена свойством *params* отдельных объектов заголовков, возвращаемых методами доступа к заголовкам.257258#### `get_param(param, failobj=None, header='content-type', unquote=True)`259260Возвращает значение параметра *param* заголовка *Content-Type* в виде строки. Если сообщение не содержит заголовка *Content-Type* или такого параметра нет, возвращается *failobj* (по умолчанию `None`).261262Необязательный параметр *header*, если указан, задаёт заголовок сообщения, который следует использовать вместо *Content-Type*.263264Ключи параметров всегда сравниваются без учёта регистра. Возвращаемое значение может быть строкой или кортежем из трёх элементов, если параметр был закодирован по [**RFC 2231**](https://python-all.ru/3/library/email.compat32-message.html). Если это кортеж из трёх элементов, элементы значения имеют вид `(CHARSET, LANGUAGE, VALUE)`. Обратите внимание, что и `CHARSET`, и `LANGUAGE` могут быть `None`; в этом случае следует считать, что `VALUE` закодирован в кодировке `us-ascii`. Обычно `LANGUAGE` можно игнорировать.265266Если вашему приложению безразлично, был ли параметр закодирован по [**RFC 2231**](https://python-all.ru/3/library/email.compat32-message.html), можно свернуть значение параметра, вызвав [`email.utils.collapse_rfc2231_value()`](https://python-all.ru/3/library/email.utils.html#email.utils.collapse_rfc2231_value) и передав возвращаемое значение из `get_param()`. Это вернёт подходящим образом декодированную строку Unicode, если значение является кортежем, или исходную строку без кавычек, если нет. Например:267268```python269rawparam = msg.get_param('foo')270param = email.utils.collapse_rfc2231_value(rawparam)271```272273В любом случае значение параметра (возвращённая строка или элемент `VALUE` кортежа из трёх элементов) всегда не экранируется, если только *unquote* не установлен в `False`.274275Это устаревший метод. В классе [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) его функциональность заменена свойством *params* отдельных объектов заголовков, возвращаемых методами доступа к заголовкам.276277#### `set_param(param, value, header='Content-Type', requote=True, charset=None, language='', replace=False)`278279Устанавливает параметр в заголовке *Content-Type*. Если параметр уже существует в заголовке, его значение будет заменено на *value*. Если заголовок *Content-Type* ещё не задан для этого сообщения, он будет установлен в *text/plain*, а новое значение параметра будет добавлено в соответствии с [**RFC 2045**](https://python-all.ru/3/library/email.compat32-message.html).280281Необязательный параметр *header* задаёт альтернативный заголовок для *Content-Type*; все параметры будут экранированы при необходимости, если только необязательный параметр *requote* не равен `False` (по умолчанию `True`).282283Если указан необязательный параметр *charset*, параметр будет закодирован в соответствии с [**RFC 2231**](https://python-all.ru/3/library/email.compat32-message.html). Необязательный параметр *language* задаёт язык по RFC 2231, по умолчанию – пустая строка. И *charset*, и *language* должны быть строками.284285Если *replace* равен `False` (по умолчанию), заголовок перемещается в конец списка заголовков. Если *replace* равен `True`, заголовок будет обновлён на месте.286287Изменено в версии 3.4: добавлен ключевой аргумент `replace`.288289#### `del_param(param, header='content-type', requote=True)`290291Полностью удаляет указанный параметр из заголовка *Content-Type*. Заголовок будет перезаписан на месте без параметра и его значения. Все значения будут экранированы при необходимости, если только *requote* не равен `False` (по умолчанию `True`). Необязательный параметр *header* задаёт альтернативу заголовку *Content-Type*.292293#### `set_type(type, header='Content-Type', requote=True)`294295Устанавливает основной тип и подтип для заголовка *Content-Type*. *type* должен быть строкой вида *maintype/subtype*, в противном случае возбуждается [`ValueError`](https://python-all.ru/3/library/exceptions.html#ValueError).296297Этот метод заменяет заголовок *Content-Type*, сохраняя все параметры на месте. Если *requote* равен `False`, экранирование существующего заголовка остаётся без изменений; в противном случае параметры будут экранированы (по умолчанию).298299Альтернативный заголовок можно указать в аргументе *header*. При установке заголовка *Content-Type* также добавляется заголовок *MIME-Version*.300301Это устаревший метод. В классе [`EmailMessage`](https://python-all.ru/3/library/email.message.html#email.message.EmailMessage) его функциональность заменена методами `make_` и `add_`.302303#### `get_filename(failobj=None)`304305Возвращает значение параметра `filename` заголовка *Content-Disposition* сообщения. Если заголовок не содержит параметра `filename`, этот метод обращается к поиску параметра `name` в заголовке *Content-Type*. Если ни один не найден или заголовок отсутствует, возвращается *failobj*. Возвращаемая строка всегда не экранируется в соответствии с [`email.utils.unquote()`](https://python-all.ru/3/library/email.utils.html#email.utils.unquote).306307#### `get_boundary(failobj=None)`308309Возвращает значение параметра `boundary` заголовка *Content-Type* сообщения, или *failobj*, если заголовок отсутствует или не содержит параметра `boundary`. Возвращаемая строка всегда не экранируется в соответствии с [`email.utils.unquote()`](https://python-all.ru/3/library/email.utils.html#email.utils.unquote).310311#### `set_boundary(boundary)`312313Устанавливает параметр `boundary` заголовка *Content-Type* в *boundary*. `set_boundary()` всегда будет заключать *boundary* в кавычки при необходимости. Если у объекта сообщения нет заголовка *Content-Type*, вызывается [`HeaderParseError`](https://python-all.ru/3/library/email.errors.html#email.errors.HeaderParseError).314315Обратите внимание, что использование этого метода незначительно отличается от удаления старого заголовка *Content-Type* и добавления нового с новым boundary через [`add_header()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.add_header), поскольку `set_boundary()` сохраняет порядок заголовка *Content-Type* в списке заголовков. Однако он *не* сохраняет строки продолжения, которые могли быть в исходном заголовке *Content-Type*.316317#### `get_content_charset(failobj=None)`318319Возвращает параметр `charset` заголовка *Content-Type*, приведённый к нижнему регистру. Если заголовок *Content-Type* отсутствует или в нём нет параметра `charset`, возвращается *failobj*.320321Обратите внимание, что этот метод отличается от [`get_charset()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_charset), который возвращает экземпляр [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset) для кодировки тела сообщения по умолчанию.322323#### `get_charsets(failobj=None)`324325Возвращает список, содержащий названия кодировок в сообщении. Если сообщение *multipart*, то список будет содержать по одному элементу для каждой вложенной части в полезной нагрузке, в противном случае – список из одного элемента.326327Каждый элемент списка будет строкой, которая является значением параметра `charset` в заголовке *Content-Type* для представленной вложенной части. Однако если у вложенной части нет заголовка *Content-Type*, нет параметра `charset`, или она не относится к основному MIME-типу *text*, то такой элемент списка будет равен *failobj*.328329#### `get_content_disposition()`330331Возвращает значение (без параметров) заголовка *Content-Disposition* сообщения, приведённое к нижнему регистру, если он есть, или `None`. Возможные значения для этого метода: *inline*, *attachment* или `None`, если сообщение соответствует [**RFC 2183**](https://python-all.ru/3/library/email.compat32-message.html).332333Добавлено в версии 3.5.334335#### `walk()`336337Метод `walk()` – это универсальный генератор, который можно использовать для обхода всех частей и вложенных частей дерева объектов сообщения в порядке обхода в глубину. Обычно `walk()` используется как итератор в цикле `for`; каждая итерация возвращает следующую вложенную часть.338339Вот пример, который выводит MIME-тип каждой части multipart-сообщения:340341```pycon342>>> for part in msg.walk():343...     print(part.get_content_type())344multipart/report345text/plain346message/delivery-status347text/plain348text/plain349message/rfc822350text/plain351```352353`walk` перебирает вложенные части любой части, для которой [`is_multipart()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.is_multipart) возвращает `True`, даже если `msg.get_content_maintype() == 'multipart'` может вернуть `False`. Это можно увидеть в нашем примере, используя отладочную вспомогательную функцию `_structure`:354355```pycon356>>> for part in msg.walk():357...     print(part.get_content_maintype() == 'multipart',358...           part.is_multipart())359True True360False False361False True362False False363False False364False True365False False366>>> _structure(msg)367multipart/report368    text/plain369    message/delivery-status370        text/plain371        text/plain372    message/rfc822373        text/plain374```375376Здесь части `message` не являются `multiparts`, но они содержат вложенные части. `is_multipart()` возвращает `True`, а `walk` спускается во вложенные части.377378Объекты `Message` также могут опционально содержать два атрибута экземпляра, которые можно использовать при создании обычного текста MIME-сообщения.379380#### `preamble`381382Формат MIME-документа допускает размещение некоторого текста между пустой строкой после заголовков и первой строкой границы multipart. Обычно этот текст не виден в почтовых программах с поддержкой MIME, так как он находится за пределами стандартной оболочки MIME. Однако при просмотре необработанного текста сообщения или при просмотре сообщения в программе без поддержки MIME этот текст может стать видимым.383384Атрибут *preamble* содержит этот начальный текст вне оболочки для MIME-документов. Когда [`Parser`](https://python-all.ru/3/library/email.parser.html#email.parser.Parser) обнаруживает некоторый текст после заголовков, но перед первой строкой границы, он присваивает этот текст атрибуту *preamble* сообщения. Когда [`Generator`](https://python-all.ru/3/library/email.generator.html#email.generator.Generator) выводит текстовое представление MIME-сообщения и находит, что сообщение имеет атрибут *preamble*, он записывает этот текст в область между заголовками и первой границей. Подробнее см. [`email.parser`](https://python-all.ru/3/library/email.parser.html#module-email.parser) и [`email.generator`](https://python-all.ru/3/library/email.generator.html#module-email.generator).385386Обратите внимание, что если объект сообщения не содержит preamble, атрибут *preamble* будет равен `None`.387388#### `epilogue`389390Атрибут *epilogue* действует так же, как атрибут *preamble*, за исключением того, что он содержит текст, который появляется между последней границей и концом сообщения.391392Нет необходимости устанавливать epilogue в пустую строку, чтобы [`Generator`](https://python-all.ru/3/library/email.generator.html#email.generator.Generator) выводил символ новой строки в конце файла.393394#### `defects`395396Атрибут *defects* содержит список всех проблем, обнаруженных при разборе этого сообщения. Подробное описание возможных дефектов разбора см. в [`email.errors`](https://python-all.ru/3/library/email.errors.html#module-email.errors).397