email.mime: Создание объектов электронной почты и MIME с нуля

Исходный код: Lib/email/mime/

Этот модуль является частью устаревшего (Compat32) API электронной почты. Его функциональность частично заменена классом contentmanager в новом API, но в определённых приложениях эти классы могут по-прежнему быть полезными, даже в коде, не относящемся к устаревшему.

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

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

Вот эти классы:

class email.mime.base.MIMEBase(_maintype, _subtype, *, policy=compat32, **_params)

Модуль: email.mime.base

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

_maintype — это основной тип Content-Type (например, текст или изображение), а _subtype — это вспомогательный тип Content-Type (например, простой или gif). _params — это словарь параметров ключ/значение, который передаётся непосредственно в Message.add_header.

Если указан параметр policy (по умолчанию — политика compat32), он будет передан в Message.

Класс MIMEBase всегда добавляет заголовок Content-Type (основанный на _maintype, _subtype и _params) и заголовок MIME-Version (всегда установленный на 1.0).

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.nonmultipart.MIMENonMultipart

Модуль: email.mime.nonmultipart

Этот подкласс MIMEBase — это промежуточный базовый класс для сообщений MIME, которые не являются multipart. Главная цель этого класса — предотвратить использование метода attach(), который имеет смысл только для сообщений multipart. Если вызвать attach(), будет поднято исключение MultipartConversionError.

class email.mime.multipart.MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)

Модуль: email.mime.multipart

Этот подкласс MIMEBase — это промежуточный базовый класс для сообщений MIME, которые являются multipart. Необязательный параметр _subtype по умолчанию устанавливается в mixed, но может быть использован для указания типа подсообщения. В объект сообщения будет добавлен заголовок Content-Type со значением multipart/_subtype. Также будет добавлен заголовок MIME-Version.

Необязательный параметр boundary — строка разделителя multipart. Когда %%%CODE_BLOCK_25%% (значение по умолчанию), разделитель вычисляется при необходимости (например, при сериализации сообщения).

_subparts — это последовательность начальных подсообщений для полезной нагрузки. Эта последовательность должна быть преобразуема в список. Вы всегда можете прикрепить новые подсообщения к сообщению, используя метод Message.attach.

Необязательный параметр policy по умолчанию имеет значение compat32.

Дополнительные параметры заголовка Content-Type берутся из ключевых аргументов или передаются в аргумент _params, который является словарем ключевых слов.

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.application.MIMEApplication(_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Модуль: email.mime.application

Подкласс MIMENonMultipart, класс MIMEApplication используется для представления объектов сообщений MIME с основным типом application. _data — строка, содержащая исходные байтовые данные. Необязательный параметр _subtype указывает тип MIME и по умолчанию имеет значение octet-stream.

Необязательный параметр _encoder — это вызываемый объект (т. е. функция), который выполняет фактическое кодирование данных для передачи. Этот вызываемый объект принимает один аргумент, который является экземпляром MIMEApplication. Он должен использовать get_payload() и set_payload() для изменения полезной нагрузки в закодированную форму. Он также должен добавить любые заголовки Content-Transfer-Encoding или другие необходимые заголовки в объект сообщения. По умолчанию используется кодировка base64. См. модуль email.encoders для списка встроенных кодировщиков.

Необязательный параметр policy по умолчанию имеет значение compat32.

_params передаются непосредственно конструктору базового класса.

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.audio.MIMEAudio(_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Модуль: email.mime.audio

Подкласс MIMENonMultipart, класс MIMEAudio используется для создания объектов сообщений MIME с основным типом audio. _audiodata — это строка, содержащая исходные данные аудио. Если эти данные могут быть декодированы стандартным модулем Python sndhdr, то тип подсообщения будет автоматически включён в заголовок Content-Type. Иначе вы можете явно указать тип аудио через аргумент _subtype. Если тип подсообщения нельзя было определить, а _subtype не был задан, то будет поднято исключение TypeError.

Необязательный параметр _encoder — это вызываемый объект (т. е. функция), который выполняет фактическое кодирование данных аудио для передачи. Этот вызываемый объект принимает один аргумент, который является экземпляром MIMEAudio. Он должен использовать get_payload() и set_payload() для изменения полезной нагрузки в закодированную форму. Он также должен добавить любые заголовки Content-Transfer-Encoding или другие необходимые заголовки в объект сообщения. По умолчанию используется кодировка base64. См. модуль email.encoders для списка встроенных кодировщиков.

Необязательный параметр policy по умолчанию имеет значение compat32.

_params передаются непосредственно конструктору базового класса.

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.image.MIMEImage(_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Модуль: email.mime.image

Подкласс MIMENonMultipart, класс MIMEImage используется для создания объектов MIME сообщений основного типа image. _imagedata — строка, содержащая исходные данные изображения. Если эти данные могут быть декодированы стандартным модулем Python imghdr, то подтип будет автоматически включён в заголовок Content-Type. В противном случае вы можете явно указать подтип изображения через аргумент _subtype. Если незначительный тип не удалось определить, а _subtype не был задан, то возникает TypeError.

Необязательный аргумент _encoder — это вызываемый объект (например, функция), который выполнит фактическое кодирование данных изображения для передачи. Этот вызываемый объект принимает один аргумент, который является экземпляром MIMEImage. Он должен использовать get_payload() и set_payload() для изменения полезной нагрузки на закодированную форму. Он также должен добавлять любые заголовки Content-Transfer-Encoding или другие необходимые заголовки к объекту сообщения. По умолчанию используется кодировка base64. Список встроенных кодировщиков см. в модуле email.encoders.

Необязательный аргумент policy по умолчанию равен compat32.

_params передаются непосредственно конструктору MIMEBase.

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.message.MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32)

Модуль: email.mime.message

Подкласс MIMENonMultipart, класс MIMEMessage используется для создания объектов MIME основного типа message. _msg используется как полезная нагрузка и должен быть экземпляром класса Message (или его подкласса), иначе возникает TypeError.

Необязательный _subtype устанавливает подтип сообщения; по умолчанию он равен rfc822.

Необязательный аргумент policy по умолчанию равен compat32.

Изменено в версии 3.6: Добавлен ключевой параметр policy.

class email.mime.text.MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)

Модуль: email.mime.text

Подкласс MIMENonMultipart, класс MIMEText используется для создания объектов MIME основного типа text. _text — строка для полезной нагрузки. _subtype — незначительный тип и по умолчанию равен plain. _charset — кодировка символов текста и передаётся как аргумент конструктору MIMENonMultipart; по умолчанию он равен us-ascii если строка содержит только ascii символы, и utf-8 в противном случае. Параметр _charset принимает либо строку, либо экземпляр Charset.

Если аргумент _charset не задан явно как None, созданный объект MIMEText будет иметь заголовок Content-Type с параметром charset, и заголовок Content-Transfer-Encoding. Это означает, что последующий вызов set_payload не приведёт к закодированной полезной нагрузке, даже если кодировка символов передана в команде set_payload. Вы можете «сбросить» это поведение, удалив заголовок Content-Transfer-Encoding, после чего вызов set_payload автоматически закодирует новую полезную нагрузку (и добавит новый заголовок Content-Transfer-Encoding).

Необязательный аргумент policy по умолчанию равен compat32.

Изменено в версии 3.5: _charset также принимает экземпляры Charset.

Изменено в версии 3.6: Добавлен ключевой параметр policy.