poplib – клиент протокола POP3¶poplib – POP3 protocol client

Объекты POP3¶POP3 Objects

Все команды POP3 представлены методами с теми же именами в нижнем регистре; большинство возвращает текст ответа, отправленный сервером.

Экземпляр POP3 имеет следующие методы:

POP3.set_debuglevel(level)¶

Устанавливает уровень отладки экземпляра. Это контролирует объём выводимой отладочной информации. Значение по умолчанию, 0, не даёт отладочного вывода. Значение 1 даёт умеренный объём отладочного вывода, как правило, одну строку на запрос. Значение 2 или выше даёт максимальный объём отладочного вывода, с записью каждой строки, отправленной и полученной по управляющему соединению.

POP3.getwelcome()¶

Возвращает приветственную строку, отправленную POP3-сервером.

POP3.capa()¶

Запрашивает возможности сервера, как указано в RFC 2449. Возвращает словарь в формате {'name': ['param'...]}.

Добавлено в версии 3.4.

POP3.user(username)¶

Отправляет команду USER; ответ должен указать, что требуется пароль.

POP3.pass_(password)¶

Отправляет пароль; ответ включает количество сообщений и размер почтового ящика. Примечание: почтовый ящик на сервере блокируется до вызова quit().

POP3.apop(user, secret)¶

Использует более безопасную аутентификацию APOP для входа на POP3-сервер.

POP3.rpop(user)¶

Использует аутентификацию RPOP (аналогично UNIX-командам r-*) для входа на POP3-сервер.

POP3.stat()¶

Получает статус почтового ящика. Результат – кортеж из двух целых чисел: (message count, mailbox size).

POP3.list([which])¶

Запрашивает список сообщений; результат возвращается в формате (response, ['mesg_num octets', ...], octets). Если задан which, это номер сообщения для вывода списка.

POP3.retr(which)¶

Извлекает сообщение номер which целиком и устанавливает его флаг прочитанности. Результат возвращается в формате (response, ['line', ...], octets).

POP3.dele(which)¶

Помечает сообщение номер which для удаления. На большинстве серверов удаление фактически не выполняется до команды QUIT (основное исключение – Eudora QPOP, который намеренно нарушает RFC, выполняя отложенные удаления при любом разрыве соединения).

POP3.rset()¶

Удаляет все пометки удаления для почтового ящика.

POP3.noop()¶

Ничего не делает. Может использоваться для поддержания соединения.

POP3.quit()¶

Завершение сеанса: фиксирует изменения, разблокирует почтовый ящик, закрывает соединение.

POP3.top(which, howmuch)¶

Извлекает заголовок сообщения и howmuch строк после заголовка сообщения номер which. Результат возвращается в формате (response, ['line', ...], octets).

Команда TOP POP3, используемая этим методом, в отличие от команды RETR, не устанавливает флаг прочитанности сообщения; к сожалению, TOP плохо специфицирован в RFC и часто некорректно работает на серверах малоизвестных производителей. Перед использованием этого метода проверьте его вручную на тех POP3-серверах, с которыми вы будете работать, прежде чем доверять ему.

POP3.uidl(which=None)¶

Возвращает список дайджестов сообщений (уникальных идентификаторов). Если указан which, результат содержит уникальный идентификатор для этого сообщения в формате 'response mesgnum uid, в противном случае результат – список (response, ['mesgnum uid', ...], octets).

POP3.utf8()¶

Пытается переключиться в режим UTF-8. В случае успеха возвращает ответ сервера, в противном случае возбуждает error_proto. Описано в RFC 6856.

Добавлено в версии 3.5.

POP3.stls(context=None)¶

Запускает сеанс TLS на активном соединении, как описано в RFC 2595. Это разрешено только до аутентификации пользователя.

Параметр context – это объект ssl.SSLContext, который позволяет объединять параметры конфигурации SSL, сертификаты и закрытые ключи в единую (потенциально долгоживущую) структуру. Рекомендуется прочитать раздел Вопросы безопасности для получения наилучших практик.

Этот метод поддерживает проверку имени хоста через ssl.SSLContext.check_hostname и Server Name Indication (см. ssl.HAS_SNI).

Добавлено в версии 3.4.

Экземпляры POP3_SSL не имеют дополнительных методов. Интерфейс этого подкласса идентичен родительскому.

Пример POP3¶POP3 Example

Вот минимальный пример (без проверки ошибок), который открывает почтовый ящик и извлекает и выводит все сообщения:

import getpass, poplib

M = poplib.POP3('localhost')
M.user(getpass.getuser())
M.pass_(getpass.getpass())
numMessages = len(M.list()[1])
for i in range(numMessages):
    for j in M.retr(i+1)[1]:
        print(j)

В конце модуля есть тестовый раздел, содержащий более полный пример использования.