poplib — Клиент протокола POP3¶

Объекты POP3¶

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

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

POP3.set_debuglevel(level)¶

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

POP3.getwelcome()¶

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

POP3.capa()¶

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

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

POP3.user(username)¶

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

POP3.pass_(password)¶

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

POP3.apop(user, secret)¶

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

POP3.rpop(user)¶

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

POP3.stat()¶

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

POP3.list([which])¶

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

POP3.retr(which)¶

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

POP3.dele(which)¶

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

POP3.rset()¶

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

POP3.noop()¶

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

POP3.quit()¶

Подписание: фиксация изменений, разблокировка почтового ящика, сброс соединения.

POP3.top(which, howmuch)¶

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

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

POP3.uidl(which=None)¶

Возвращает список дайджестов сообщений (уникальных идентификаторов). Если указано which, результат содержит уникальный id для данного сообщения в виде '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¶

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

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)

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