imaplib — Клиент протокола IMAP4¶

Объекты IMAP4¶

Все команды IMAP4rev1 представлены методами с одинаковыми именами, как в верхнем, так и в нижнем регистре.

Все аргументы команд преобразуются в строки, за исключением AUTHENTICATE и последнего аргумента APPEND, который передается как литерал IMAP4. При необходимости (строка содержит символы, зависящие от протокола IMAP4, и не заключена ни в круглые скобки, ни в двойные кавычки) каждая строка берется в кавычки. Однако аргумент password для команды LOGIN всегда берется в кавычки. Если вы хотите избежать заключения строки аргумента в кавычки (например, аргумента flags для STORE), то заключите строку в круглые скобки (например: r'(\Deleted)').

Каждая команда возвращает кортеж: (type, [data, ...]), где type обычно означает 'OK' или 'NO', а data - это либо текст из ответа на команду, либо обязательные результаты выполнения команды. Все данные представляют собой либо bytes, либо кортеж. Если это кортеж, то первая часть является заголовком ответа, а вторая часть содержит данные (т.е. «буквальное» значение).

Параметры message_set для приведенных ниже команд - это строка, указывающая одно или несколько сообщений, на основании которых необходимо выполнить действия. Это может быть простой номер сообщения ('1'), диапазон номеров сообщений ('2:4'), или группа несмежных диапазонов, разделенных запятыми ('1:3,6:9'). Диапазон может содержать звездочку, указывающую на бесконечную верхнюю границу ('3:*').

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

IMAP4.append(mailbox, flags, date_time, message)¶

Добавьте сообщение в указанный почтовый ящик.

IMAP4.authenticate(mechanism, authobject)¶

Команда аутентификации — требует обработки ответа.

механизм указывает, какой механизм аутентификации должен использоваться - он должен отображаться в переменной экземпляра capabilities в виде AUTH=mechanism.

authobject должен быть вызываемым объектом:

data = authobject(response)

Он будет вызван для обработки ответов сервера на продолжение работы; передаваемый аргумент response будет bytes. Он должен возвращать bytes данные, которые будут закодированы в base64 и отправлены на сервер. Он должен возвращать None, если вместо этого следует отправить ответ об отмене клиента *.

Изменено в версии 3.5: строковые имена пользователей и пароли теперь кодируются как utf-8 вместо того, чтобы ограничиваться ASCII.

IMAP4.check()¶

Проверьте почтовый ящик на сервере.

IMAP4.close()¶

Закройте выбранный в данный момент почтовый ящик. Удаленные сообщения удаляются из почтового ящика, доступного для записи. Это рекомендуемая команда перед LOGOUT.

IMAP4.copy(message_set, new_mailbox)¶

Скопируйте сообщения message_set в конец new_mailbox.

IMAP4.create(mailbox)¶

Создайте новый почтовый ящик с именем mailbox.

IMAP4.delete(mailbox)¶

Удалите старый почтовый ящик с именем mailbox.

IMAP4.deleteacl(mailbox, who)¶

Удалите списки управления доступом (удалите все права), установленные для пользователей в почтовом ящике.

IMAP4.enable(capability)¶

Включите возможность (см. RFC 5161). Большинство функций включать не требуется. В настоящее время поддерживается только функция UTF8=ACCEPT (см. RFC 6855).

Добавлено в версии 3.5: Сам метод enable() и поддержка RFC 6855.

IMAP4.expunge()¶

Безвозвратно удаляет удаленные элементы из выбранного почтового ящика. Генерирует ответ EXPUNGE для каждого удаленного сообщения. Возвращаемые данные содержат список номеров сообщений EXPUNGE в порядке поступления.

IMAP4.fetch(message_set, message_parts)¶

Извлекать (части) сообщений. message_parts должно быть строкой имен частей сообщения, заключенных в круглые скобки, например: "(UID BODY[TEXT])". Возвращаемые данные представляют собой кортежи конверта и данных части сообщения.

IMAP4.getacl(mailbox)¶

Получите ACLs для почтового ящика. Метод является нестандартным, но поддерживается сервером Cyrus.

IMAP4.getannotation(mailbox, entry, attribute)¶

Извлеките указанные ANNOTATIONs для почтового ящика. Метод является нестандартным, но поддерживается сервером Cyrus.

IMAP4.getquota(root)¶

Получите данные об использовании ресурсов quota root и их ограничениях. Этот метод является частью расширения квоты IMAP4, определенного в rfc2087.

IMAP4.getquotaroot(mailbox)¶

Получите список quota roots для именованного почтового ящика. Этот метод является частью расширения квоты IMAP4, определенного в rfc2087.

IMAP4.list([directory[, pattern]])¶

Перечислите имена почтовых ящиков в каталоге, соответствующие шаблону. По умолчанию в каталоге используется почтовая папка верхнего уровня, а в шаблоне по умолчанию все соответствует. Возвращаемые данные содержат список LIST ответов.

IMAP4.login(user, password)¶

Идентифицируйте клиента, используя текстовый пароль. Пароль будет указан в кавычках.

IMAP4.login_cram_md5(user, password)¶

Принудительное использование аутентификации CRAM-MD5 при идентификации клиента для защиты пароля. Будет работать только в том случае, если ответ сервера CAPABILITY содержит фразу AUTH=CRAM-MD5.

IMAP4.logout()¶

Отключение соединения с сервером. Возвращает ответ сервера BYE.

Изменено в версии 3.8: Метод больше не игнорирует молчаливо произвольные исключения.

IMAP4.lsub(directory='""', pattern='*')¶

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

IMAP4.myrights(mailbox)¶

Покажите мои списки управления доступом для почтового ящика (т.е. права, которые у меня есть на почтовый ящик).

IMAP4.namespace()¶

Возвращает пространства имен IMAP, как определено в RFC 2342.

IMAP4.noop()¶

Отправьте NOOP на сервер.

IMAP4.open(host, port, timeout=None)¶

Открывает сокет для подключения к порту на хосте. Необязательный параметр timeout определяет время ожидания в секундах для попытки подключения. Если время ожидания не указано или равно None, используется глобальное время ожидания сокета по умолчанию. Также обратите внимание, что если параметру timeout присвоено значение, равное нулю, то будет выдан ValueError, что означает отказ от создания неблокирующего сокета. Этот метод неявно вызывается конструктором IMAP4. Объекты подключения, установленные этим методом, будут использоваться в методах IMAP4.read(), IMAP4.readline(), IMAP4.send(), и IMAP4.shutdown(). Вы можете переопределить этот метод.

Создает auditing event imaplib.open с аргументами self, host, port.

Изменено в версии 3.9: Был добавлен параметр timeout.

IMAP4.partial(message_num, message_part, start, length)¶

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

IMAP4.proxyauth(user)¶

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

IMAP4.read(size)¶

Считывает размер в байтах с удаленного сервера. Вы можете переопределить этот метод.

IMAP4.readline()¶

Считывает одну строку с удаленного сервера. Вы можете переопределить этот метод.

IMAP4.recent()¶

Запросите у сервера обновление. Возвращаемые данные равны None, если новых сообщений нет, в противном случае значение ответа равно RECENT.

IMAP4.rename(oldmailbox, newmailbox)¶

Переименуйте почтовый ящик с именем oldmailbox в newmailbox.

IMAP4.response(code)¶

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

IMAP4.search(charset, criterion[, ...])¶

Найдите в почтовом ящике соответствующие сообщения. кодировка может быть None, в этом случае в запросе к серверу не будет указано CHARSET. Протокол IMAP требует, чтобы был указан хотя бы один критерий; исключение будет вызвано, когда сервер вернет сообщение об ошибке. кодировка должна быть None, если функция UTF8=ACCEPT была включена с помощью команды enable().

Пример:

# M is a connected IMAP4 instance...
typ, msgnums = M.search(None, 'FROM', '"LDJ"')

# or:
typ, msgnums = M.search(None, '(FROM "LDJ")')

IMAP4.select(mailbox='INBOX', readonly=False)¶

Выберите почтовый ящик. Возвращаемые данные - это количество сообщений в почтовом ящике (EXISTS ответ). Значение почтового ящика по умолчанию равно 'INBOX'. Если установлен флаг только для чтения, изменения в почтовом ящике запрещены.

IMAP4.send(data)¶

Отправляет data на удаленный сервер. Вы можете переопределить этот метод.

Создает auditing event imaplib.send с аргументами self, data.

IMAP4.setacl(mailbox, who, what)¶

Установите ACL для почтового ящика. Метод является нестандартным, но поддерживается сервером Cyrus.

IMAP4.setannotation(mailbox, entry, attribute[, ...])¶

Установите ANNOTATIONs для почтового ящика. Метод является нестандартным, но поддерживается сервером Cyrus.

IMAP4.setquota(root, limits)¶

Установите ограничения на ресурсы quota для root. Этот метод является частью расширения квоты IMAP4, определенного в rfc2087.

IMAP4.shutdown()¶

Закрыть соединение, установленное в open. Этот метод неявно вызывается в IMAP4.logout(). Вы можете переопределить этот метод.

IMAP4.socket()¶

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

IMAP4.sort(sort_criteria, charset, search_criterion[, ...])¶

Команда sort является вариантом команды search с семантикой сортировки результатов. Возвращаемые данные содержат разделенный пробелом список совпадающих номеров сообщений.

Сортировка имеет два аргумента перед аргументом(ами) search_criterion; список sort_criteria, заключенный в круглые скобки, и кодировку для поиска. Обратите внимание, что в отличие от search, аргумент searching charset является обязательным. Существует также команда uid sort, которая соответствует sort так же, как uid search соответствует search. Команда sort сначала выполняет поиск в почтовом ящике сообщений, соответствующих заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях поиска. Затем она возвращает номера соответствующих сообщений.

Это команда расширения IMAP4rev1.

IMAP4.starttls(ssl_context=None)¶

Отправьте команду STARTTLS. Аргумент ssl_context необязателен и должен быть ssl.SSLContext. Это позволит включить шифрование в IMAP-соединении. Пожалуйста, ознакомьтесь с рекомендациями в Соображения безопасности.

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

Изменено в версии 3.4: Метод теперь поддерживает проверку имени хоста с помощью ssl.SSLContext.check_hostname и Указание имени сервера (см. ssl.HAS_SNI).

IMAP4.status(mailbox, names)¶

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

IMAP4.store(message_set, command, flag_list)¶

Изменяет расположение флагов для сообщений в почтовом ящике. команда указана в разделе 6.4.6 раздела RFC 2060 как один из «ФЛАГОВ», «+ФЛАГОВ» или «-ФЛАГОВ», необязательно с суффиксом «.SILENT».

Например, чтобы установить флажок удаления для всех сообщений:

typ, data = M.search(None, 'ALL')
for num in data[0].split():
   M.store(num, '+FLAGS', '\\Deleted')
M.expunge()

Примечание

Создание флагов, содержащих «]» (например, «[test]»), нарушает RFC 3501 (протокол IMAP). Однако imaplib исторически разрешал создание таких тегов, а популярные серверы IMAP, такие как Gmail, принимают и выдают такие флаги. Существуют программы, не использующие Python, которые также создают такие теги. Хотя это является нарушением RFC и предполагается, что клиенты и серверы IMAP должны быть строгими, imaplib, тем не менее, продолжает разрешать создание таких тегов из соображений обратной совместимости и, начиная с версии Python 3.6, обрабатывает их, если они отправляются с сервера, поскольку это улучшает совместимость в реальном мире.

IMAP4.subscribe(mailbox)¶

Подпишитесь на новый почтовый ящик.

IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])¶

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

Элементы потока состоят из нуля или более номеров сообщений, разделенных пробелами, указывающих на последовательные родительские и дочерние сообщения.

У Thread есть два аргумента перед аргументом(ами) search_criterion; threading_algorithm и поисковая кодировка. Обратите внимание, что в отличие от search, аргумент для поиска кодировки является обязательным. Существует также команда uid thread, которая соответствует thread так же, как uid search соответствует search. Команда thread сначала выполняет поиск в почтовом ящике сообщений, соответствующих заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях поиска. Затем она возвращает соответствующие сообщения, обработанные в соответствии с указанным алгоритмом обработки.

Это команда расширения IMAP4rev1.

IMAP4.uid(command, arg[, ...])¶

Выполняет команды с сообщениями, идентифицируемыми по UID, а не по номеру сообщения. Возвращает ответ, соответствующий команде. Должен быть указан хотя бы один аргумент; если он не указан, сервер вернет сообщение об ошибке и будет создано исключение.

IMAP4.unsubscribe(mailbox)¶

Отписаться от старого почтового ящика.

IMAP4.unselect()¶

imaplib.IMAP4.unselect() освобождает ресурсы сервера, связанные с выбранным почтовым ящиком, и возвращает сервер в состояние проверки подлинности. Эта команда выполняет те же действия, что и imaplib.IMAP4.close(), за исключением того, что никакие сообщения не удаляются безвозвратно из текущего выбранного почтового ящика.

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

IMAP4.xatom(name[, ...])¶

Разрешить простые команды расширения, о которых сервер уведомляет в ответе CAPABILITY.

Следующие атрибуты определены для экземпляров IMAP4:

IMAP4.PROTOCOL_VERSION¶

Самый последний поддерживаемый протокол в CAPABILITY ответе сервера.

IMAP4.debug¶

Целочисленное значение для управления отладочным выводом. Значение инициализации берется из переменной модуля Debug. Значения, превышающие три, отслеживают каждую команду.

IMAP4.utf8_enabled¶

Логическое значение, которое обычно равно False, но устанавливается равным True, если для возможности UTF8=ACCEPT успешно выполнена команда enable().

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

Пример IMAP4¶

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

import getpass, imaplib

M = imaplib.IMAP4(host='example.org')
M.login(getpass.getuser(), getpass.getpass())
M.select()
typ, data = M.search(None, 'ALL')
for num in data[0].split():
    typ, data = M.fetch(num, '(RFC822)')
    print('Message %s\n%s\n' % (num, data[0][1]))
M.close()
M.logout()