`smtplib.md`

282 строк · 27.1 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/library/smtplib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.15. [`smtplib`](https://python-all.ru/3.2/library/smtplib.html#module-smtplib) – клиент протокола SMTP89**Исходный код:** [Lib/smtplib.py](https://python-all.ru/src/3.2/Lib/smtplib.py)1011---1213Модуль [`smtplib`](https://python-all.ru/3.2/library/smtplib.html#module-smtplib) определяет объект сеанса клиента SMTP, который можно использовать для отправки почты на любой компьютер в сети с демоном SMTP или ESMTP. Подробнее о работе SMTP и ESMTP см. в [**RFC 821**](https://python-all.ru/3.2/library/smtplib.html) (Протокол простой передачи почты) и [**RFC 1869**](https://python-all.ru/3.2/library/smtplib.html) (SMTP Service Extensions).1415#### `class smtplib.SMTP(host='', port=0, local_hostname=None[, timeout])`1617Экземпляр [`SMTP`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP) инкапсулирует SMTP-соединение. Он содержит методы, поддерживающие полный набор операций SMTP и ESMTP. Если указаны необязательные параметры host и port, то при инициализации вызывается метод SMTP [`connect()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.connect) с этими параметрами. Исключение [`SMTPConnectError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPConnectError) возникает, если указанный хост не отвечает должным образом. Необязательный параметр *timeout* задаёт таймаут в секундах для блокирующих операций, таких как попытка подключения (если он не указан, будет использоваться глобальная настройка таймаута по умолчанию).1819Для обычного использования достаточно методов инициализации/подключения, [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail) и `quit()`. Пример приведён ниже.2021#### `class smtplib.SMTP_SSL(host='', port=0, local_hostname=None, keyfile=None, certfile=None[, timeout])`2223Экземпляр [`SMTP_SSL`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP_SSL) ведёт себя точно так же, как экземпляры [`SMTP`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP). [`SMTP_SSL`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP_SSL) следует использовать в ситуациях, когда SSL требуется с самого начала соединения, а использование `starttls()` не подходит. Если *host* не указан, используется локальный хост. Если *port* равен нулю, используется стандартный порт SMTP-over-SSL (465). Параметры *keyfile* и *certfile* также необязательны и могут содержать закрытый ключ в формате PEM и файл цепочки сертификатов для SSL-соединения. Необязательный параметр *timeout* задаёт таймаут в секундах для блокирующих операций, таких как попытка подключения (если он не указан, будет использоваться глобальная настройка таймаута по умолчанию).2425#### `class smtplib.LMTP(host='', port=LMTP_PORT, local_hostname=None)`2627Протокол LMTP, очень похожий на ESMTP, во многом основан на стандартном клиенте SMTP. Для LMTP обычно используются Unix-сокеты, поэтому наш `connect()` метод должен поддерживать как их, так и обычный сервер вида host:port. Чтобы указать Unix-сокет, нужно использовать абсолютный путь для параметра *host*, начинающийся с '/'.2829Поддерживается аутентификация с использованием стандартного механизма SMTP. При использовании Unix-сокета LMTP обычно не поддерживает и не требует аутентификации, но результат может отличаться.3031Также определен неплохой набор исключений:3233#### `exception smtplib.SMTPException`3435Базовый класс исключений для всех исключений, порождаемых этим модулем.3637#### `exception smtplib.SMTPServerDisconnected`3839Это исключение возбуждается, когда сервер неожиданно разрывает соединение или когда предпринимается попытка использовать экземпляр [`SMTP`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP) до подключения к серверу.4041#### `exception smtplib.SMTPResponseException`4243Базовый класс для всех исключений, включающих код ошибки SMTP. Эти исключения генерируются в некоторых случаях, когда сервер SMTP возвращает код ошибки. Код ошибки хранится в атрибуте `smtp_code` объекта исключения, а атрибут `smtp_error` содержит сообщение об ошибке.4445#### `exception smtplib.SMTPSenderRefused`4647Адрес отправителя отклонён. В дополнение к атрибутам, устанавливаемым для всех исключений [`SMTPResponseException`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPResponseException), в этом исключении атрибут 'sender' принимает значение строки, которую сервер SMTP отклонил.4849#### `exception smtplib.SMTPRecipientsRefused`5051Все адреса получателей отклонены. Ошибки для каждого получателя доступны через атрибут `recipients`, который представляет собой словарь того же типа, что возвращает [`SMTP.sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail).5253#### `exception smtplib.SMTPDataError`5455Сервер SMTP отказался принимать данные сообщения.5657#### `exception smtplib.SMTPConnectError`5859Произошла ошибка при установке соединения с сервером.6061#### `exception smtplib.SMTPHeloError`6263Сервер отклонил наше сообщение `HELO`.6465#### `exception smtplib.SMTPAuthenticationError`6667Произошла ошибка аутентификации SMTP. Скорее всего, сервер не принял предоставленную комбинацию имени пользователя и пароля.6869> **См. также**70>71> **[**RFC 821**](https://python-all.ru/3.2/library/smtplib.html) – Простой протокол передачи почты**72>73> Определение протокола SMTP. Этот документ описывает модель, порядок работы и детали протокола SMTP.74>75> **[**RFC 1869**](https://python-all.ru/3.2/library/smtplib.html) – Расширения службы SMTP**76>77> Определение расширений ESMTP для SMTP. Описывается инфраструктура для расширения SMTP новыми командами, динамическое обнаружение команд, предоставляемых сервером, и определяются несколько дополнительных команд.7879## 20.15.1. Объекты SMTP8081Экземпляр [`SMTP`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP) имеет следующие методы:8283#### `SMTP.set_debuglevel(level)`8485Устанавливает уровень отладочного вывода. Значение *level*, равное истине, приводит к выводу отладочных сообщений для соединения и для всех сообщений, отправленных на сервер и полученных от него.8687#### `SMTP.connect(host='localhost', port=0)`8889Подключается к хосту на указанном порту. По умолчанию выполняется подключение к локальному хосту на стандартном порту SMTP (25). Если имя хоста заканчивается двоеточием (`':'`), за которым следует число, этот суффикс отбрасывается, а число интерпретируется как номер порта для использования. Этот метод автоматически вызывается конструктором, если хост указан при создании экземпляра.9091#### `SMTP.docmd(cmd, args='')`9293Отправляет команду *cmd* серверу. Необязательный аргумент *args* просто дописывается к команде через пробел.9495Возвращает кортеж из двух элементов: числового кода ответа и собственно строки ответа (многострочные ответы объединяются в одну длинную строку).9697При обычной работе нет необходимости явно вызывать этот метод. Он используется для реализации других методов и может быть полезен при тестировании частных расширений.9899Если соединение с сервером теряется во время ожидания ответа, будет возбуждено исключение [`SMTPServerDisconnected`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPServerDisconnected).100101#### `SMTP.helo(name='')`102103Идентификация на SMTP-сервере выполняется с помощью `HELO`. Аргумент hostname по умолчанию принимает полностью определённое доменное имя локального хоста. Сообщение, возвращаемое сервером, сохраняется в атрибуте `helo_resp` объекта.104105В обычной работе явно вызывать этот метод не требуется. Он будет вызван неявно методом [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail) при необходимости.106107#### `SMTP.ehlo(name='')`108109Идентификация на ESMTP-сервере выполняется с помощью `EHLO`. Аргумент hostname по умолчанию принимает полностью определённое доменное имя локального хоста. Проверить ответ на наличие опций ESMTP и сохранить их для использования методом [`has_extn()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.has_extn). Также устанавливаются несколько информационных атрибутов: сообщение, возвращаемое сервером, сохраняется в атрибуте `ehlo_resp`; атрибут `does_esmtp` устанавливается в true или false в зависимости от того, поддерживает ли сервер ESMTP, а `esmtp_features` будет словарём, содержащим имена расширений SMTP-сервиса, которые поддерживает этот сервер, и их параметры (если есть).110111Если нет необходимости использовать [`has_extn()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.has_extn) перед отправкой почты, вызывать этот метод явно не требуется. Он будет вызван неявно методом [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail) при необходимости.112113#### `SMTP.ehlo_or_helo_if_needed()`114115Этот метод вызывает [`ehlo()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.ehlo) и/или [`helo()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.helo), если за эту сессию ещё не было предыдущей команды `EHLO` или `HELO`. Он сначала пытается использовать ESMTP `EHLO`.116117**[`SMTPHeloError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPHeloError)**118119Сервер не ответил должным образом на приветствие120121`HELO`122123.124125#### `SMTP.has_extn(name)`126127Возвращает [`True`](https://python-all.ru/3.2/library/constants.html#True), если *name* присутствует в наборе расширений SMTP-сервиса, возвращённых сервером, иначе [`False`](https://python-all.ru/3.2/library/constants.html#False). Регистр не учитывается.128129#### `SMTP.verify(address)`130131Check the validity of an address on this server using SMTP `VRFY`. Returns a tuple consisting of code 250 and a full [**RFC 822**](https://python-all.ru/3.2/library/smtplib.html) address (including human name) if the user address is valid. Otherwise returns an SMTP error code of 400 or greater and an error string.132133> **Примечание**134>135> Многие сайты отключают SMTP `VRFY`, чтобы помешать спамерам.136137#### `SMTP.login(user, password)`138139Выполнить вход на SMTP-сервер, требующий аутентификации. Аргументами являются имя пользователя и пароль для аутентификации. Если за эту сессию ещё не было предыдущей команды `EHLO` или `HELO`, этот метод сначала пытается использовать ESMTP `EHLO`. Этот метод завершится нормально, если аутентификация прошла успешно, или может вызвать следующие исключения:140141**[`SMTPHeloError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPHeloError)**142143Сервер не ответил должным образом на приветствие144145`HELO`146147.148149**[`SMTPAuthenticationError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPAuthenticationError)**150151Сервер не принял комбинацию имя пользователя/пароль.152153**[`SMTPException`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPException)**154155Не найден подходящий метод аутентификации.156157#### `SMTP.starttls(keyfile=None, certfile=None)`158159Перевести SMTP-соединение в режим TLS (безопасность транспортного уровня). Все последующие SMTP-команды будут зашифрованы. После этого следует снова вызвать [`ehlo()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.ehlo).160161Если указаны *keyfile* и *certfile*, они передаются функции [`ssl()`](https://python-all.ru/3.2/library/ssl.html#module-ssl) модуля [`socket`](https://python-all.ru/3.2/library/socket.html#module-socket).162163Если за эту сессию ещё не было предыдущей команды `EHLO` или `HELO`, этот метод сначала пытается использовать ESMTP `EHLO`.164165**[`SMTPHeloError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPHeloError)**166167Сервер не ответил должным образом на приветствие168169`HELO`170171.172173**[`SMTPException`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPException)**174175Сервер не поддерживает расширение STARTTLS.176177**[`RuntimeError`](https://python-all.ru/3.2/library/exceptions.html#RuntimeError)**178179Интерпретатор Python не поддерживает SSL/TLS.180181#### `SMTP.sendmail(from_addr, to_addrs, msg, mail_options=[], rcpt_options=[])`182183Отправка почты. Обязательные аргументы: строка адреса отправителя в формате [**RFC 822**](https://python-all.ru/3.2/library/smtplib.html), список строк адресов получателей в формате [**RFC 822**](https://python-all.ru/3.2/library/smtplib.html) (отдельная строка будет рассматриваться как список с одним адресом) и строка сообщения. Вызывающий может передать список параметров ESMTP (например, `8bitmime`) для использования в командах `MAIL FROM` как *mail\_options*. Параметры ESMTP (например, команды `DSN`), которые следует использовать со всеми командами `RCPT`, можно передать как *rcpt\_options*. (Если нужно использовать разные параметры ESMTP для разных получателей, придётся использовать низкоуровневые методы, такие как `mail()`, `rcpt()` и `data()` для отправки сообщения.)184185> **Примечание**186>187> Параметры *from\_addr* и *to\_addrs* используются для построения конверта сообщения, используемого транспортными агентами. `sendmail` никак не изменяет заголовки сообщения.188189*msg* может быть строкой, содержащей символы в диапазоне ASCII, или байтовой строкой. Строка кодируется в байты с помощью кодека ascii, а отдельные символы `\r` и `\n` преобразуются в `\r\n`. Байтовая строка не изменяется.190191Если в этом сеансе ещё не было предыдущей команды `EHLO` или `HELO`, этот метод сначала пробует ESMTP `EHLO`. Если сервер поддерживает ESMTP, ему передаётся размер сообщения и каждый из указанных параметров (если параметр входит в набор возможностей, объявляемых сервером). Если `EHLO` не удаётся, предпринимается попытка `HELO`, а параметры ESMTP отбрасываются.192193Метод завершается нормально, если почта принята хотя бы одним получателем. В противном случае возбуждается исключение. То есть, если метод не возбуждает исключение, значит, кто-то должен получить ваше письмо. Если метод не возбуждает исключение, он возвращает словарь с одной записью для каждого получателя, которому было отказано. Каждая запись содержит кортеж из кода ошибки SMTP и соответствующего сообщения об ошибке, отправленного сервером.194195Этот метод может возбуждать следующие исключения:196197**[`SMTPRecipientsRefused`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPRecipientsRefused)**198199Все получатели были отклонены. Почту не получил никто. Атрибут200201`recipients`202203объекта исключения представляет собой словарь с информацией об отклонённых получателях (аналогичный тому, который возвращается, когда был принят хотя бы один получатель).204205**[`SMTPHeloError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPHeloError)**206207Сервер не ответил должным образом на приветствие208209`HELO`210211.212213**[`SMTPSenderRefused`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPSenderRefused)**214215Сервер не принял адрес216217*from\_addr*218219.220221**[`SMTPDataError`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTPDataError)**222223Сервер ответил неожиданным кодом ошибки (не связанным с отказом отдельному получателю).224225Если не указано иное, соединение остаётся открытым даже после возбуждения исключения.226227Изменено в версии 3.2: *msg* может быть строкой байтов.228229#### `SMTP.send_message(msg, from_addr=None, to_addrs=None, mail_options=[], rcpt_options=[])`230231Это удобный метод для вызова [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail) с сообщением, представленным объектом [`email.message.Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message). Аргументы имеют то же значение, что и для [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail), за исключением того, что *msg* является объектом `Message`.232233Если *from\_addr* равно `None` или *to\_addrs* равно `None`, `send_message` заполняет эти аргументы адресами, извлечёнными из заголовков *msg* в соответствии с [**RFC 2822**](https://python-all.ru/3.2/library/smtplib.html): *from\_addr* устанавливается в поле *Sender* (если оно присутствует), в противном случае – в поле *From*. *to\_adresses* объединяет значения (если они есть) полей *To*, *Cc* и *Bcc* из *msg*. Если в сообщении встречается ровно один набор заголовков *Resent-\**, обычные заголовки игнорируются и используются заголовки *Resent-\**. Если сообщение содержит более одного набора заголовков *Resent-\**, возбуждается [`ValueError`](https://python-all.ru/3.2/library/exceptions.html#ValueError), поскольку нет способа однозначно определить самый последний набор заголовков *Resent-*.234235`send_message` сериализует *msg* с помощью [`BytesGenerator`](https://python-all.ru/3.2/library/email.generator.html#email.generator.BytesGenerator) с `\r\n` в качестве *linesep* и вызывает [`sendmail()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.sendmail) для передачи полученного сообщения. Независимо от значений *from\_addr* и *to\_addrs*, `send_message` не передаёт никакие заголовки *Bcc* или *Resent-Bcc*, которые могут присутствовать в *msg*.236237Новое в версии 3.2.238239#### `SMTP.quit()`240241Завершает сеанс SMTP и закрывает соединение. Возвращает результат команды SMTP `QUIT`.242243Также поддерживаются низкоуровневые методы, соответствующие стандартным командам SMTP/ESMTP: `HELP`, `RSET`, `NOOP`, `MAIL`, `RCPT` и `DATA`. Обычно их не нужно вызывать напрямую, поэтому они здесь не документируются. Подробности см. в коде модуля.244245## 20.15.2. Пример SMTP246247Этот пример запрашивает у пользователя адреса, необходимые в конверте сообщения (адреса ‘To’\\nи ‘From’), а также само сообщение для отправки. Обратите внимание, что заголовки,\\nкоторые должны быть включены в сообщение, должны быть включены в сообщение при вводе; этот\\nпример не выполняет никакой обработки заголовков [**RFC 822**](https://python-all.ru/3.2/library/smtplib.html). В частности,\\nадреса ‘To’ и ‘From’ должны быть явно включены в заголовки сообщения.248249```python250import smtplib251252def prompt(prompt):253    return input(prompt).strip()254255fromaddr = prompt("From: ")256toaddrs  = prompt("To: ").split()257print("Enter message, end with ^D (Unix) or ^Z (Windows):")258259# Добавьте заголовки From: и To: в начало!260msg = ("From: %s\r\nTo: %s\r\n\r\n"261       % (fromaddr, ", ".join(toaddrs)))262while True:263    try:264        line = input()265    except EOFError:266        break267    if not line:268        break269    msg = msg + line270271print("Message length is", len(msg))272273server = smtplib.SMTP('localhost')274server.set_debuglevel(1)275server.sendmail(fromaddr, toaddrs, msg)276server.quit()277```278279> **Примечание**280>281> В целом рекомендуется использовать возможности пакета [`email`](https://python-all.ru/3.2/library/email.html#module-email) для создания сообщения электронной почты, которое затем можно отправить с помощью [`send_message()`](https://python-all.ru/3.2/library/smtplib.html#smtplib.SMTP.send_message); см. [*email: Примеры*](https://python-all.ru/3.2/library/email-examples.html#email-examples).282