`email.mime.md`

124 строк · 19.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/library/email.mime.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `email.mime`: создание email и MIME-объектов с нуля89**Исходный код:** [Lib/email/mime/](https://python-all.ru/src/3.14/Lib/email/mime)1011---1213Этот модуль является частью устаревшего (`Compat32`) email API. Его функциональность частично заменена [`contentmanager`](https://python-all.ru/3/library/email.contentmanager.html#module-email.contentmanager) в новом API, но в некоторых приложениях эти классы могут по-прежнему быть полезными, даже в неустаревшем коде.1415Обычно структура объекта сообщения получается передачей файла или текста парсеру, который разбирает текст и возвращает корневой объект сообщения. Однако можно также построить полную структуру сообщения с нуля или даже отдельные [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) объекты вручную. Более того, можно взять существующую структуру и добавить новые `Message` объекты, перемещать их и т.д. Это делает очень удобным интерфейс для разделения и обработки MIME сообщений.1617Можно создать новую структуру объекта, создавая экземпляры [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) , добавляя вложения и все соответствующие заголовки вручную. Однако для MIME-сообщений пакет [`email`](https://python-all.ru/3/library/email.html#module-email) предоставляет несколько удобных подклассов, которые упрощают задачу.1819Вот классы:2021#### `class email.mime.base.MIMEBase(_maintype, _subtype, *, policy=compat32, **_params)`2223Модуль: [`email.mime.base`](https://python-all.ru/3/library/email.mime.html#module-email.mime.base)2425Это базовый класс для всех MIME-специфических подклассов [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message). Обычно не создаются экземпляры непосредственно `MIMEBase`, хотя это возможно. `MIMEBase` предоставляется в первую очередь как удобный базовый класс для более специализированных подклассов, работающих с MIME.2627*\_maintype* – это основной тип *Content-Type* (например, *text* или *image*), а *\_subtype* – это подтип *Content-Type* (например, *plain* или *gif*). *\_params* – это словарь ключей/значений параметров, который передаётся напрямую в [`Message.add_header`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.add_header).2829Если указан *policy* (по умолчанию используется политика [`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).3031Класс `MIMEBase` всегда добавляет заголовок *Content-Type* (на основе *\_maintype*, *\_subtype* и *\_params*) и заголовок *MIME-Version* (всегда установлен в `1.0`).3233Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключевому слову.3435#### `class email.mime.nonmultipart.MIMENonMultipart`3637Модуль: [`email.mime.nonmultipart`](https://python-all.ru/3/library/email.mime.html#module-email.mime.nonmultipart)3839Подкласс [`MIMEBase`](https://python-all.ru/3/library/email.mime.html#email.mime.base.MIMEBase), это промежуточный базовый класс для MIME-сообщений, которые не являются *multipart*. Основная цель этого класса – предотвратить использование метода [`attach()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.attach), который имеет смысл только для сообщений *multipart*. Если `attach()` вызывается, возбуждается исключение [`MultipartConversionError`](https://python-all.ru/3/library/email.errors.html#email.errors.MultipartConversionError).4041#### `class email.mime.multipart.MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)`4243Модуль: [`email.mime.multipart`](https://python-all.ru/3/library/email.mime.html#module-email.mime.multipart)4445Подкласс [`MIMEBase`](https://python-all.ru/3/library/email.mime.html#email.mime.base.MIMEBase), это промежуточный базовый класс для MIME-сообщений, которые являются *multipart*. Необязательный параметр *\_subtype* по умолчанию равен *mixed*, но может использоваться для указания подтипа сообщения. Заголовок *Content-Type* со значением *multipart/\_subtype* будет добавлен к объекту сообщения. Также будет добавлен заголовок *MIME-Version*.4647Необязательный параметр *boundary* – строка границы для multipart. Если `None` (по умолчанию), граница вычисляется при необходимости (например, при сериализации сообщения).4849*\_subparts* – последовательность начальных подчастей для полезной нагрузки. Эта последовательность должна быть преобразуема в список. Новые подчасти всегда можно присоединить к сообщению с помощью метода [`Message.attach`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.attach).5051Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).5253Дополнительные параметры для заголовка *Content-Type* берутся из именованных аргументов или передаются в аргумент *\_params*, который является словарём именованных аргументов.5455Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключевому слову.5657#### `class email.mime.application.MIMEApplication(_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)`5859Модуль: [`email.mime.application`](https://python-all.ru/3/library/email.mime.html#module-email.mime.application)6061Подкласс [`MIMENonMultipart`](https://python-all.ru/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart), класс `MIMEApplication` используется для представления MIME-сообщений основного типа *application*. *\_data* содержит байты необработанных данных приложения. Необязательный параметр *\_subtype* указывает MIME-подтип и по умолчанию равен *octet-stream*.6263Необязательный параметр *\_encoder* – это вызываемый объект (т.е. функция), который выполняет фактическое кодирование данных для передачи. Этот вызываемый объект принимает один аргумент – экземпляр `MIMEApplication`. Он должен использовать [`get_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_payload) и [`set_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.set_payload) для преобразования полезной нагрузки в закодированную форму. Также он должен при необходимости добавить заголовок *Content-Transfer-Encoding* или другие заголовки к объекту сообщения. Кодирование по умолчанию – base64. Список встроенных кодировщиков приведён в модуле [`email.encoders`](https://python-all.ru/3/library/email.encoders.html#module-email.encoders).6465Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).6667*\_params* передаются напрямую конструктору базового класса.6869Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключевому слову.7071#### `class email.mime.audio.MIMEAudio(_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)`7273Модуль: [`email.mime.audio`](https://python-all.ru/3/library/email.mime.html#module-email.mime.audio)7475Подкласс [`MIMENonMultipart`](https://python-all.ru/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart), класс `MIMEAudio` используется для создания MIME-объектов сообщений основного типа *audio*. *\_audiodata* содержит байты необработанных аудиоданных. Если эти данные можно декодировать как au, wav, aiff или aifc, то подтип будет автоматически включён в заголовок *Content-Type*. В противном случае можно явно указать аудиоподтип через аргумент *\_subtype*. Если подтип не удалось определить, а *\_subtype* не был указан, возбуждается исключение [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError).7677Необязательный *\_encoder* – это вызываемый объект (т.е. функция), который выполняет непосредственное кодирование аудиоданных для передачи. Этот вызываемый объект принимает один аргумент – экземпляр `MIMEAudio`. Он должен использовать [`get_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_payload) и [`set_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.set_payload), чтобы преобразовать полезную нагрузку в закодированную форму. Также он должен при необходимости добавить заголовки *Content-Transfer-Encoding* или другие заголовки к объекту сообщения. По умолчанию используется кодировка base64. Список встроенных кодировщиков приведён в модуле [`email.encoders`](https://python-all.ru/3/library/email.encoders.html#module-email.encoders).7879Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).8081*\_params* передаются напрямую конструктору базового класса.8283Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключу.8485#### `class email.mime.image.MIMEImage(_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)`8687Модуль: [`email.mime.image`](https://python-all.ru/3/library/email.mime.html#module-email.mime.image)8889Подкласс [`MIMENonMultipart`](https://python-all.ru/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart), класс `MIMEImage` используется для создания MIME-объектов сообщений основного типа *image*. *\_imagedata* содержит байты необработанных данных изображения. Если тип этих данных можно определить (проверяются jpeg, png, gif, tiff, rgb, pbm, pgm, ppm, rast, xbm, bmp, webp и exr), то подтип будет автоматически включён в заголовок *Content-Type*. В противном случае можно явно указать подтип изображения через аргумент *\_subtype*. Если подтип не удалось определить, а *\_subtype* не был указан, возбуждается исключение [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError).9091Необязательный *\_encoder* – это вызываемый объект (т.е. функция), который выполняет непосредственное кодирование данных изображения для передачи. Этот вызываемый объект принимает один аргумент – экземпляр `MIMEImage`. Он должен использовать [`get_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.get_payload) и [`set_payload()`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message.set_payload), чтобы преобразовать полезную нагрузку в закодированную форму. Также он должен при необходимости добавить заголовки *Content-Transfer-Encoding* или другие заголовки к объекту сообщения. По умолчанию используется кодировка base64. Список встроенных кодировщиков приведён в модуле [`email.encoders`](https://python-all.ru/3/library/email.encoders.html#module-email.encoders).9293Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).9495*\_params* передаются напрямую конструктору [`MIMEBase`](https://python-all.ru/3/library/email.mime.html#email.mime.base.MIMEBase).9697Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключу.9899#### `class email.mime.message.MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32)`100101Модуль: [`email.mime.message`](https://python-all.ru/3/library/email.mime.html#module-email.mime.message)102103Подкласс [`MIMENonMultipart`](https://python-all.ru/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart), класс `MIMEMessage` используется для создания MIME-объектов основного типа *message*. *\_msg* используется в качестве полезной нагрузки и должен быть экземпляром класса [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) (или его подкласса), в противном случае возбуждается исключение [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError).104105Необязательный *\_subtype* задаёт подтип сообщения; по умолчанию *rfc822*.106107Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).108109Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключу.110111#### `class email.mime.text.MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)`112113Модуль: [`email.mime.text`](https://python-all.ru/3/library/email.mime.html#module-email.mime.text)114115Подкласс [`MIMENonMultipart`](https://python-all.ru/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart), класс `MIMEText` используется для создания MIME-объектов основного типа *text*. *\_text* – строка для полезной нагрузки. *\_subtype* – подтип, по умолчанию *plain*. *\_charset* – набор символов текста; передаётся в качестве аргумента конструктору `MIMENonMultipart`; по умолчанию `us-ascii`, если строка содержит только кодовые точки `ascii`, и `utf-8` в противном случае. Параметр *\_charset* принимает как строку, так и экземпляр [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset).116117Если аргумент *\_charset* явно не установлен в `None`, созданный объект MIMEText будет иметь заголовки *Content-Type* с параметром `charset` и *Content-Transfer-Encoding*. Это означает, что последующий вызов `set_payload` не приведёт к кодированию полезной нагрузки, даже если в команду `set_payload` передан набор символов. Чтобы «сбросить» это поведение, можно удалить заголовок `Content-Transfer-Encoding`, после чего вызов `set_payload` автоматически закодирует новую полезную нагрузку (и добавит новый заголовок *Content-Transfer-Encoding*).118119Необязательный аргумент *policy* по умолчанию равен [`compat32`](https://python-all.ru/3/library/email.policy.html#email.policy.Compat32).120121Изменено в версии 3.5: *\_charset* также принимает экземпляры [`Charset`](https://python-all.ru/3/library/email.charset.html#email.charset.Charset).122123Изменено в версии 3.6: Добавлен параметр *policy*, передаваемый только по ключу.124