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

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

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

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

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

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

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

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

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

_maintype — это основное значение Content-Type (например, text или image), а _subtype — это второстепенное значение Content-Type (например, plain или 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. Когда None, (по умолчанию), граница рассчитывается по мере необходимости (например, когда сообщение сериализуется).

_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.