`poplib.md`

136 строк · 11.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/library/poplib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.14. [`poplib`](https://python-all.ru/3.3/library/poplib.html#module-poplib) – клиент протокола POP389**Исходный код:** [Lib/poplib.py](https://python-all.ru/src/3.3/Lib/poplib.py)1011---1213Этот модуль определяет класс [`POP3`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3), который инкапсулирует соединение с POP3-сервером и реализует протокол, определённый в [**RFC 1725**](https://python-all.ru/3.3/library/poplib.html). Класс [`POP3`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3) поддерживает как минимальный, так и дополнительный набор команд. Кроме того, этот модуль предоставляет класс [`POP3_SSL`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3_SSL), который обеспечивает поддержку подключения к POP3-серверам, использующим SSL в качестве базового протокольного уровня.1415Обратите внимание, что POP3, хотя и широко поддерживается, является устаревшим. Качество реализации POP3-серверов сильно варьируется, и слишком многие оставляют желать лучшего. Если почтовый сервер поддерживает IMAP, лучше использовать класс [`imaplib.IMAP4`](https://python-all.ru/3.3/library/imaplib.html#imaplib.IMAP4), так как IMAP-серверы обычно реализованы лучше.1617Модуль [`poplib`](https://python-all.ru/3.3/library/poplib.html#module-poplib) предоставляет два класса:1819#### `class poplib.POP3(host, port=POP3_PORT[, timeout])`2021Этот класс реализует собственно протокол POP3. Соединение создаётся при инициализации экземпляра. Если параметр *port* опущен, используется стандартный порт POP3 (110). Необязательный параметр *timeout* задаёт тайм-аут в секундах для попытки подключения (если не указан, будет использована глобальная настройка тайм-аута по умолчанию).2223#### `class poplib.POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)`2425Это подкласс [`POP3`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3), который подключается к серверу через SSL-зашифрованный сокет. Если параметр *port* не указан, используется порт 995 – стандартный порт POP3-over-SSL. Параметры *keyfile* и *certfile* также необязательны – они могут содержать PEM-форматированный закрытый ключ и файл цепочки сертификатов для SSL-соединения. Параметр *timeout* работает так же, как в конструкторе [`POP3`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3). Параметр *context* – это объект [`ssl.SSLContext`](https://python-all.ru/3.3/library/ssl.html#ssl.SSLContext), который позволяет объединить параметры конфигурации SSL, сертификаты и закрытые ключи в одну (потенциально долгоживущую) структуру.2627Изменено в версии 3.2: Добавлен параметр *context*.2829Одно исключение определено как атрибут модуля [`poplib`](https://python-all.ru/3.3/library/poplib.html#module-poplib):3031#### `exception poplib.error_proto`3233Исключение, возбуждаемое при любых ошибках этого модуля (ошибки из модуля [`socket`](https://python-all.ru/3.3/library/socket.html#module-socket) не перехватываются). Причина исключения передаётся конструктору в виде строки.3435> **См. также**36>37> **Модуль [`imaplib`](https://python-all.ru/3.3/library/imaplib.html#module-imaplib)**38>39> Стандартный модуль Python для IMAP.40>41> **[Часто задаваемые вопросы о Fetchmail](https://python-all.ru/3.3/library/poplib.html)**42>43> FAQ для POP/IMAP-клиента44>45> **fetchmail**46>47> содержит информацию о вариациях POP3-серверов и несоблюдении RFC, которая может быть полезна, если вам нужно написать приложение на основе протокола POP.4849## 21.14.1. Объекты POP35051Все команды POP3 представлены одноимёнными методами в нижнем регистре; большинство из них возвращает текст ответа, отправленный сервером.5253Экземпляр [`POP3`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3) имеет следующие методы:5455#### `POP3.set_debuglevel(level)`5657Устанавливает уровень отладки экземпляра. Это контролирует объём выводимой отладочной информации. Значение по умолчанию, `0`, не даёт отладочного вывода. Значение `1` даёт умеренный объём отладочного вывода, как правило, одну строку на запрос. Значение `2` или выше даёт максимальный объём отладочного вывода, с записью каждой строки, отправленной и полученной по управляющему соединению.5859#### `POP3.getwelcome()`6061Возвращает приветственную строку, отправленную POP3-сервером.6263#### `POP3.user(username)`6465Отправляет команду USER; ответ должен указать, что требуется пароль.6667#### `POP3.pass_(password)`6869Отправляет пароль, ответ включает количество сообщений и размер почтового ящика. Примечание: почтовый ящик на сервере блокируется до вызова `quit()`.7071#### `POP3.apop(user, secret)`7273Использует более безопасную аутентификацию APOP для входа на POP3-сервер.7475#### `POP3.rpop(user)`7677Использует аутентификацию RPOP (аналогично UNIX-командам r-\*) для входа на POP3-сервер.7879#### `POP3.stat()`8081Получает статус почтового ящика. Результат – кортеж из двух целых чисел: `(message count, mailbox size)`.8283#### `POP3.list([which])`8485Запрашивает список сообщений, результат имеет вид `(response, ['mesg_num octets', ...], octets)`. Если задан параметр *which*, это номер сообщения для вывода списка.8687#### `POP3.retr(which)`8889Извлекает полное сообщение номер *which* и устанавливает флаг просмотра. Результат имеет вид `(response, ['line', ...], octets)`.9091#### `POP3.dele(which)`9293Помечает сообщение номер *which* для удаления. На большинстве серверов удаление фактически не выполняется до команды QUIT (основное исключение – Eudora QPOP, который намеренно нарушает RFC, выполняя отложенные удаления при любом разрыве соединения).9495#### `POP3.rset()`9697Удаляет все пометки удаления для почтового ящика.9899#### `POP3.noop()`100101Ничего не делает. Может использоваться для поддержания соединения.102103#### `POP3.quit()`104105Завершение сеанса: фиксирует изменения, разблокирует почтовый ящик, закрывает соединение.106107#### `POP3.top(which, howmuch)`108109Извлекает заголовок сообщения и *howmuch* строк после заголовка для сообщения с номером *which*. Результат возвращается в формате `(response, ['line', ...], octets)`.110111Команда TOP POP3, используемая этим методом, в отличие от команды RETR, не устанавливает флаг прочитанности сообщения; к сожалению, TOP плохо специфицирован в RFC и часто некорректно работает на серверах малоизвестных производителей. Перед использованием этого метода проверьте его вручную на тех POP3-серверах, с которыми вы будете работать, прежде чем доверять ему.112113#### `POP3.uidl(which=None)`114115Возвращает список дайджестов сообщений (уникальных идентификаторов). Если указан *which*, результат содержит уникальный идентификатор для этого сообщения в формате `'response mesgnum uid`, в противном случае результат представляет собой список `(response, ['mesgnum uid', ...], octets)`.116117Экземпляры [`POP3_SSL`](https://python-all.ru/3.3/library/poplib.html#poplib.POP3_SSL) не имеют дополнительных методов. Интерфейс этого подкласса идентичен родительскому.118119## 21.14.2. Пример POP3120121Вот минимальный пример (без проверки ошибок), который открывает почтовый ящик и извлекает и выводит все сообщения:122123```python124import getpass, poplib125126M = poplib.POP3('localhost')127M.user(getpass.getuser())128M.pass_(getpass.getpass())129numMessages = len(M.list()[1])130for i in range(numMessages):131    for j in M.retr(i+1)[1]:132        print(j)133```134135В конце модуля есть тестовый раздел, содержащий более полный пример использования.136