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)¶

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

POP3.stat()¶

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

POP3.list([which])¶

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

POP3.retr(which)¶

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

POP3.dele(which)¶

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

POP3.rset()¶

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

POP3.noop()¶

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

POP3.quit()¶

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

POP3.top(which, howmuch)¶

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

Команда POP3 TOP, используемая в этом методе, в отличие от команды 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 и Указания имени сервера (см. 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)

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