`poplib.md`

178 строк · 16.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.11/library/poplib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`poplib`](https://python-all.ru/3.11/library/poplib.html#module-poplib) – клиент протокола POP389**Исходный код:** [Lib/poplib.py](https://python-all.ru/src/3.11/Lib/poplib.py)1011---1213Этот модуль определяет класс [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3), который инкапсулирует соединение с POP3-сервером и реализует протокол, определённый в [**RFC 1939**](https://python-all.ru/3.11/library/poplib.html). Класс [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3) поддерживает как минимальный, так и дополнительный наборы команд из [**RFC 1939**](https://python-all.ru/3.11/library/poplib.html). Класс [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3) также поддерживает команду `STLS`, введённую в [**RFC 2595**](https://python-all.ru/3.11/library/poplib.html), для обеспечения шифрованной связи по уже установленному соединению.1415Кроме того, этот модуль предоставляет класс [`POP3_SSL`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3_SSL), который обеспечивает поддержку подключения к POP3-серверам, использующим SSL в качестве базового протокольного уровня.1617Обратите внимание, что POP3, хотя и широко поддерживается, устаревает. Качество реализации POP3-серверов сильно различается, и слишком многие из них довольно плохи. Если ваш почтовый сервер поддерживает IMAP, лучше использовать класс [`imaplib.IMAP4`](https://python-all.ru/3.11/library/imaplib.html#imaplib.IMAP4), так как IMAP-серверы, как правило, реализованы лучше.1819[Доступность](https://python-all.ru/3.11/library/intro.html#availability): not Emscripten, not WASI.2021Этот модуль не работает или недоступен на платформах WebAssembly `wasm32-emscripten` и `wasm32-wasi`. См. [платформы WebAssembly](https://python-all.ru/3.11/library/intro.html#wasm-availability) для получения дополнительной информации.2223Модуль [`poplib`](https://python-all.ru/3.11/library/poplib.html#module-poplib) предоставляет два класса:2425#### `class poplib.POP3(host, port=POP3_PORT[, timeout])`2627Этот класс реализует собственно протокол POP3. Соединение создаётся при инициализации экземпляра. Если параметр *port* опущен, используется стандартный порт POP3 (110). Необязательный параметр *timeout* задаёт тайм-аут в секундах для попытки подключения (если не указан, будет использована глобальная настройка тайм-аута по умолчанию).2829Вызывает [событие аудита](https://python-all.ru/3.11/library/sys.html#auditing) `poplib.connect` с аргументами `self`, `host`, `port`.3031Все команды вызывают [событие аудита](https://python-all.ru/3.11/library/sys.html#auditing) `poplib.putline` с аргументами `self` и `line`, где `line` – это байты, которые будут отправлены удалённому хосту.3233Изменено в версии 3.9: Если параметр *timeout* установлен в ноль, будет возбуждено исключение [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError), чтобы предотвратить создание неблокирующего сокета.3435#### `class poplib.POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)`3637Это подкласс [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3), который подключается к серверу через SSL-шифрованный сокет. Если *port* не указан, используется порт 995 – стандартный порт POP3 через SSL. *timeout* работает так же, как в конструкторе [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3). *context* – необязательный объект [`ssl.SSLContext`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext), который позволяет объединять параметры конфигурации SSL, сертификаты и закрытые ключи в единую (потенциально долгоживущую) структуру. Пожалуйста, прочтите [Рекомендации по безопасности](https://python-all.ru/3.11/library/ssl.html#ssl-security) для получения наилучших практик.3839*keyfile* и *certfile* – это устаревшая альтернатива *context*; они могут указывать на файлы закрытого ключа и цепочки сертификатов в формате PEM, соответственно, для SSL-соединения.4041Вызывает [событие аудита](https://python-all.ru/3.11/library/sys.html#auditing) `poplib.connect` с аргументами `self`, `host`, `port`.4243Все команды вызывают [событие аудита](https://python-all.ru/3.11/library/sys.html#auditing) `poplib.putline` с аргументами `self` и `line`, где `line` – это байты, которые будут отправлены удалённому хосту.4445Изменено в версии 3.2: Добавлен параметр *context*.4647Изменено в версии 3.4: Теперь класс поддерживает проверку имени хоста с помощью [`ssl.SSLContext.check_hostname`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext.check_hostname) и *Server Name Indication* (см. [`ssl.HAS_SNI`](https://python-all.ru/3.11/library/ssl.html#ssl.HAS_SNI)).4849Устарело с версии 3.6: *keyfile* и *certfile* устарели в пользу *context*. Вместо них используйте [`ssl.SSLContext.load_cert_chain()`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext.load_cert_chain), или позвольте [`ssl.create_default_context()`](https://python-all.ru/3.11/library/ssl.html#ssl.create_default_context) выбрать доверенные сертификаты ЦС системы.5051Изменено в версии 3.9: Если параметр *timeout* установлен в ноль, будет возбуждено исключение [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError), чтобы предотвратить создание неблокирующего сокета.5253В модуле [`poplib`](https://python-all.ru/3.11/library/poplib.html#module-poplib) определено одно исключение в качестве атрибута:5455#### `exception poplib.error_proto`5657Исключение, возбуждаемое при любых ошибках этого модуля (ошибки из модуля [`socket`](https://python-all.ru/3.11/library/socket.html#module-socket) не перехватываются). Причина исключения передаётся конструктору в виде строки.5859> **См. также**60>61> **Модуль [`imaplib`](https://python-all.ru/3.11/library/imaplib.html#module-imaplib)**62>63> Стандартный модуль Python для IMAP.64>65> **[Часто задаваемые вопросы о Fetchmail](https://python-all.ru/3.11/library/poplib.html)**66>67> FAQ для POP/IMAP-клиента **fetchmail** содержит информацию о вариациях POP3-серверов и несоблюдении RFC, которая может быть полезна, если вам нужно написать приложение на основе протокола POP.6869## Объекты POP37071Все команды POP3 представлены методами с теми же именами в нижнем регистре; большинство возвращает текст ответа, отправленный сервером.7273Экземпляр [`POP3`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3) имеет следующие методы:7475#### `POP3.set_debuglevel(level)`7677Устанавливает уровень отладки экземпляра. Это контролирует объём выводимой отладочной информации. Значение по умолчанию, `0`, не даёт отладочного вывода. Значение `1` даёт умеренный объём отладочного вывода, как правило, одну строку на запрос. Значение `2` или выше даёт максимальный объём отладочного вывода, с записью каждой строки, отправленной и полученной по управляющему соединению.7879#### `POP3.getwelcome()`8081Возвращает приветственную строку, отправленную POP3-сервером.8283#### `POP3.capa()`8485Запрашивает возможности сервера, как указано в [**RFC 2449**](https://python-all.ru/3.11/library/poplib.html). Возвращает словарь в формате `{'name': ['param'...]}`.8687Новое в версии 3.4.8889#### `POP3.user(username)`9091Отправляет команду USER; ответ должен указать, что требуется пароль.9293#### `POP3.pass_(password)`9495Отправляет пароль; ответ включает количество сообщений и размер почтового ящика. Примечание: почтовый ящик на сервере блокируется до вызова [`quit()`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3.quit).9697#### `POP3.apop(user, secret)`9899Использует более безопасную аутентификацию APOP для входа на POP3-сервер.100101#### `POP3.rpop(user)`102103Использует аутентификацию RPOP (аналогично UNIX-командам r-\*) для входа на POP3-сервер.104105#### `POP3.stat()`106107Получает статус почтового ящика. Результат – кортеж из двух целых чисел: `(message count, mailbox size)`.108109#### `POP3.list([which])`110111Запрашивает список сообщений; результат возвращается в формате `(response, ['mesg_num octets', ...], octets)`. Если задан *which*, это номер сообщения для вывода списка.112113#### `POP3.retr(which)`114115Извлекает сообщение номер *which* целиком и устанавливает его флаг прочитанности. Результат возвращается в формате `(response, ['line', ...], octets)`.116117#### `POP3.dele(which)`118119Помечает сообщение номер *which* для удаления. На большинстве серверов удаление фактически не выполняется до команды QUIT (основное исключение – Eudora QPOP, который намеренно нарушает RFC, выполняя отложенные удаления при любом разрыве соединения).120121#### `POP3.rset()`122123Удаляет все пометки удаления для почтового ящика.124125#### `POP3.noop()`126127Ничего не делает. Может использоваться для поддержания соединения.128129#### `POP3.quit()`130131Завершение сеанса: фиксирует изменения, разблокирует почтовый ящик, закрывает соединение.132133#### `POP3.top(which, howmuch)`134135Извлекает заголовок сообщения и *howmuch* строк после заголовка сообщения номер *which*. Результат возвращается в формате `(response, ['line', ...], octets)`.136137Команда TOP POP3, используемая этим методом, в отличие от команды RETR, не устанавливает флаг прочитанности сообщения; к сожалению, TOP плохо специфицирован в RFC и часто некорректно работает на серверах малоизвестных производителей. Перед использованием этого метода проверьте его вручную на тех POP3-серверах, с которыми вы будете работать, прежде чем доверять ему.138139#### `POP3.uidl(which=None)`140141Возвращает список дайджестов сообщений (уникальных идентификаторов). Если указан *which*, результат содержит уникальный идентификатор для этого сообщения в формате `'response mesgnum uid`, в противном случае результат – список `(response, ['mesgnum uid', ...], octets)`.142143#### `POP3.utf8()`144145Пытается переключиться в режим UTF-8. В случае успеха возвращает ответ сервера, в противном случае возбуждает [`error_proto`](https://python-all.ru/3.11/library/poplib.html#poplib.error_proto). Описано в [**RFC 6856**](https://python-all.ru/3.11/library/poplib.html).146147Новое в версии 3.5.148149#### `POP3.stls(context=None)`150151Запускает сеанс TLS на активном соединении, как описано в [**RFC 2595**](https://python-all.ru/3.11/library/poplib.html). Это разрешено только до аутентификации пользователя.152153Параметр *context* – это объект [`ssl.SSLContext`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext), который позволяет объединять параметры конфигурации SSL, сертификаты и закрытые ключи в единую (потенциально долгоживущую) структуру. Рекомендуется прочитать раздел [Вопросы безопасности](https://python-all.ru/3.11/library/ssl.html#ssl-security) для получения наилучших практик.154155Этот метод поддерживает проверку имени хоста через [`ssl.SSLContext.check_hostname`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext.check_hostname) и *Server Name Indication* (см. [`ssl.HAS_SNI`](https://python-all.ru/3.11/library/ssl.html#ssl.HAS_SNI)).156157Новое в версии 3.4.158159Экземпляры [`POP3_SSL`](https://python-all.ru/3.11/library/poplib.html#poplib.POP3_SSL) не имеют дополнительных методов. Интерфейс этого подкласса идентичен родительскому.160161## Пример POP3162163Вот минимальный пример (без проверки ошибок), который открывает почтовый ящик и извлекает и выводит все сообщения:164165```python166import getpass, poplib167168M = poplib.POP3('localhost')169M.user(getpass.getuser())170M.pass_(getpass.getpass())171numMessages = len(M.list()[1])172for i in range(numMessages):173    for j in M.retr(i+1)[1]:174        print(j)175```176177В конце модуля есть тестовый раздел, содержащий более полный пример использования.178