`smtpd.md`

188 строк · 17.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/library/smtpd.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.18. [`smtpd`](https://python-all.ru/3.5/library/smtpd.html#module-smtpd) – SMTP-сервер89**Исходный код:** [Lib/smtpd.py](https://python-all.ru/src/3.5/Lib/smtpd.py)1011---1213Этот модуль предоставляет несколько классов для реализации SMTP-серверов (электронной почты).1415> **См. также**16>17> Пакет [aiosmtpd](https://python-all.ru/3.5/library/smtpd.html) является рекомендуемой заменой этого модуля. Он основан на [`asyncio`](https://python-all.ru/3.5/library/asyncio.html#module-asyncio) и предоставляет более простой API. [`smtpd`](https://python-all.ru/3.5/library/smtpd.html#module-smtpd) следует считать устаревшим.1819Предусмотрено несколько реализаций сервера; одна из них – универсальная реализация, которая ничего не делает и может быть переопределена, в то время как две другие предлагают конкретные стратегии отправки почты.2021Кроме того, SMTPChannel может быть расширен для реализации очень специфического поведения взаимодействия с SMTP-клиентами.2223Код поддерживает [**RFC 5321**](https://python-all.ru/3.5/library/smtpd.html), а также расширения [**RFC 1870**](https://python-all.ru/3.5/library/smtpd.html) SIZE и [**RFC 6531**](https://python-all.ru/3.5/library/smtpd.html) SMTPUTF8.2425## 21.18.1. Объекты SMTPServer2627#### `class smtpd.SMTPServer(localaddr, remoteaddr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=True)`2829Создаёт новый объект [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer), который привязывается к локальному адресу *localaddr*. Он будет рассматривать *remoteaddr* как вышестоящий SMTP-ретранслятор. Оба *localaddr* и *remoteaddr* должны быть кортежем [(host, port)](https://python-all.ru/3.5/library/socket.html#host-port) . Объект наследуется от [`asyncore.dispatcher`](https://python-all.ru/3.5/library/asyncore.html#asyncore.dispatcher) и поэтому встраивается в цикл событий [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore) при создании.3031*data\_size\_limit* задаёт максимальное количество байт, которое будет принято в команде `DATA`. Значение `None` или `0` означает отсутствие ограничения.3233*map* – это карта сокетов для использования соединениями (в качестве подходящего значения можно использовать изначально пустой словарь). Если не указано, используется глобальная карта сокетов [`asyncore`](https://python-all.ru/3.5/library/asyncore.html#module-asyncore).3435*enable\_SMTPUTF8* определяет, следует ли включить расширение `SMTPUTF8` (как определено в [**RFC 6531**](https://python-all.ru/3.5/library/smtpd.html)). По умолчанию `False`. Если установлено `True`, *decode\_data* должно быть `False` (иначе возникает ошибка). Если `True`, `SMTPUTF8` принимается как параметр команды `MAIL` и, если присутствует, передаётся [`process_message()`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer.process_message) в списке `kwargs['mail_options']`.3637*decode\_data* определяет, должна ли часть данных SMTP-транзакции декодироваться с помощью UTF-8. По умолчанию `True` по причинам обратной совместимости, но в Python 3.6 изменится на `False`; укажите значение ключевого слова явно, чтобы избежать [`DeprecationWarning`](https://python-all.ru/3.5/library/exceptions.html#DeprecationWarning). Когда *decode\_data* установлено в `False`, сервер объявляет расширение `8BITMIME` ([**RFC 6152**](https://python-all.ru/3.5/library/smtpd.html)), принимает параметр `BODY=8BITMIME` команды `MAIL` и, если он присутствует, передаёт его [`process_message()`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer.process_message) в списке `kwargs['mail_options']`.3839#### `process_message(peer, mailfrom, rcpttos, data, **kwargs)`4041Вызывает исключение [`NotImplementedError`](https://python-all.ru/3.5/library/exceptions.html#NotImplementedError). Переопределите этот метод в подклассах, чтобы сделать что-то полезное с этим сообщением. То, что было передано в конструктор как *remoteaddr*, будет доступно как атрибут `_remoteaddr`. *peer* – адрес удалённого хоста, *mailfrom* – отправитель конверта, *rcpttos* – получатели конверта, а *data* – строка, содержащая содержимое электронного письма (которое должно быть в формате [**RFC 5321**](https://python-all.ru/3.5/library/smtpd.html) ).4243Если ключевое слово конструктора *decode\_data* установлено в `True`, аргумент *data* будет строкой Unicode. Если установлено в `False`, он будет объектом bytes.4445*kwargs* – это словарь, содержащий дополнительную информацию. Он пуст, если в качестве параметра инициализации не было указано `decode_data=False` или `enable_SMTPUTF8=True`; в противном случае он содержит следующие ключи:4647> ***mail\_options*:**48>49> список всех полученных параметров команды50>51> `MAIL`52>53> (элементы – строки в верхнем регистре; пример:54>55> `['BODY=8BITMIME', 'SMTPUTF8']`56>57> ).58>59> ***rcpt\_options*:**60>61> то же, что и62>63> *mail\_options*64>65> , но для команды66>67> `RCPT`68>69> . В настоящее время не поддерживается ни один70>71> `RCPT TO`72>73> параметр, поэтому пока это всегда будет пустой список.7475Реализации `process_message` должны использовать сигнатуру `**kwargs` для принятия произвольных именованных аргументов, поскольку будущие улучшения могут добавлять ключи в словарь kwargs.7677Верните `None` для запроса обычного ответа `250 Ok`; в противном случае верните нужную строку ответа в формате [**RFC 5321**](https://python-all.ru/3.5/library/smtpd.html).7879#### `channel_class`8081Переопределите это в подклассах, чтобы использовать собственный [`SMTPChannel`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel) для управления SMTP-клиентами.8283Новое в версии 3.4: Аргумент конструктора *map*.8485Изменено в версии 3.5: *localaddr* и *remoteaddr* теперь могут содержать IPv6-адреса.8687Новое в версии 3.5: аргументы конструктора *decode\_data* и *enable\_SMTPUTF8*, и аргумент *kwargs* для [`process_message()`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer.process_message), когда указан хотя бы один из них.8889## 21.18.2. Объекты DebuggingServer9091#### `class smtpd.DebuggingServer(localaddr, remoteaddr)`9293Создаёт новый отладочный сервер. Аргументы – как в [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer). Сообщения будут отбрасываться и выводиться на stdout.9495## 21.18.3. Объекты PureProxy9697#### `class smtpd.PureProxy(localaddr, remoteaddr)`9899Создаёт новый сервер-чистый прокси. Аргументы – как в [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer). Всё будет пересылаться на *remoteaddr*. Имейте в виду, что его запуск с большой вероятностью сделает вас открытым ретранслятором, поэтому будьте осторожны.100101## 21.18.4. Объекты MailmanProxy102103#### `class smtpd.MailmanProxy(localaddr, remoteaddr)`104105Создаёт новый чистый прокси-сервер. Аргументы те же, что и в [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer). Всё будет перенаправляться на *remoteaddr*, если только локальные настройки mailman не знают об адресе – в этом случае обработка пойдёт через mailman. Учтите, что запуск этого сервера с большой вероятностью превратит вас в открытый релей, так что будьте осторожны.106107## 21.18.5. Объекты SMTPChannel108109#### `class smtpd.SMTPChannel(server, conn, addr, data_size_limit=33554432, map=None, enable_SMTPUTF8=False, decode_data=True)`110111Создаёт новый объект [`SMTPChannel`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel), управляющий взаимодействием между сервером и одним SMTP-клиентом.112113*conn* и *addr* описаны ниже в переменных экземпляра.114115*data\_size\_limit* задаёт максимальное количество байт, которое будет принято в команде `DATA`. Значение `None` или `0` означает отсутствие ограничения.116117*enable\_SMTPUTF8* определяет, следует ли включить расширение `SMTPUTF8` (как определено в [**RFC 6531**](https://python-all.ru/3.5/library/smtpd.html)). По умолчанию `False`. Исключение [`ValueError`](https://python-all.ru/3.5/library/exceptions.html#ValueError) возникает, если *enable\_SMTPUTF8* и *decode\_data* одновременно установлены в `True`.118119Словарь можно указать в *map*, чтобы избежать использования глобальной карты сокетов.120121*decode\_data* определяет, должна ли часть данных SMTP-транзакции декодироваться с помощью UTF-8. По умолчанию `True` по причинам обратной совместимости, но в Python 3.6 изменится на `False`. Укажите значение ключевого слова явно, чтобы избежать [`DeprecationWarning`](https://python-all.ru/3.5/library/exceptions.html#DeprecationWarning).122123Чтобы использовать собственную реализацию SMTPChannel, нужно переопределить [`SMTPServer.channel_class`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer.channel_class) вашего [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer).124125Изменено в версии 3.5: добавлены аргументы *decode\_data* и *enable\_SMTPUTF8*.126127[`SMTPChannel`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel) имеет следующие переменные экземпляра:128129#### `smtp_server`130131Содержит объект [`SMTPServer`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPServer), создавший этот канал.132133#### `conn`134135Содержит объект сокета, подключённого к клиенту.136137#### `addr`138139Содержит адрес клиента – второе значение, возвращаемое [`socket.accept`](https://python-all.ru/3.5/library/socket.html#socket.socket.accept)140141#### `received_lines`142143Содержит список строк (декодированных в UTF-8), полученных от клиента. Строки имеют окончание `"\r\n"`, преобразованное в `"\n"`.144145#### `smtp_state`146147Содержит текущее состояние канала. Изначально это `COMMAND`, а затем `DATA` после того, как клиент отправит строку «DATA».148149#### `seen_greeting`150151Содержит строку с приветствием, отправленным клиентом в его «HELO».152153#### `mailfrom`154155Содержит строку с адресом, указанным в строке «MAIL FROM:» от клиента.156157#### `rcpttos`158159Содержит список строк с адресами, указанными в строках «RCPT TO:» от клиента.160161#### `received_data`162163Содержит строку со всеми данными, отправленными клиентом в состоянии DATA, включая всё до завершающего `"\r\n.\r\n"`, но не включая его.164165#### `fqdn`166167Содержит полное доменное имя сервера, возвращаемое [`socket.getfqdn()`](https://python-all.ru/3.5/library/socket.html#socket.getfqdn).168169#### `peer`170171Содержит имя клиента, возвращаемое `conn.getpeername()`, где `conn` – это [`conn`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.conn).172173[`SMTPChannel`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel) работает, вызывая методы с именем `smtp_<command>` при получении командной строки от клиента. В базовый класс [`SMTPChannel`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel) встроены методы для обработки следующих команд (и соответствующих ответов на них):174175| Команда | Выполняемое действие |176| --- | --- |177| HELO | Принимает приветствие от клиента и сохраняет его в [`seen_greeting`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.seen_greeting). Переводит сервер в режим базовых команд. |178| EHLO | Принимает приветствие от клиента и сохраняет его в [`seen_greeting`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.seen_greeting). Переводит сервер в расширенный режим команд. |179| NOOP | Не выполняет никаких действий. |180| QUIT | Корректно закрывает соединение. |181| MAIL | Принимает синтаксис «MAIL FROM:» и сохраняет указанный адрес как [`mailfrom`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.mailfrom). В расширенном режиме команд принимает атрибут SIZE [**RFC 1870**](https://python-all.ru/3.5/library/smtpd.html) и отвечает соответствующим образом в зависимости от значения *data\_size\_limit*. |182| RCPT | Принимает синтаксис «RCPT TO:» и сохраняет указанные адреса в списке [`rcpttos`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.rcpttos). |183| RSET | Сбрасывает [`mailfrom`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.mailfrom), [`rcpttos`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.rcpttos) и [`received_data`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.received_data), но не приветствие. |184| DATA | Устанавливает внутреннее состояние в `DATA` и сохраняет остальные строки от клиента в [`received_data`](https://python-all.ru/3.5/library/smtpd.html#smtpd.SMTPChannel.received_data) до получения терминатора `"\r\n.\r\n"`. |185| HELP | Возвращает минимальную информацию о синтаксисе команд |186| VRFY | Возвращает код 252 (сервер не знает, действителен ли адрес) |187| EXPN | Сообщает, что команда не реализована. |188