imaplib.md

1> **Источник:** https://python-all.ru/3.2/library/imaplib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.13. [`imaplib`](https://python-all.ru/3.2/library/imaplib.html#module-imaplib) – клиент протокола IMAP489**Исходный код:** [Lib/imaplib.py](https://python-all.ru/src/3.2/Lib/imaplib.py)1011---1213Этот модуль определяет три класса: [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4), [`IMAP4_SSL`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4_SSL) и [`IMAP4_stream`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4_stream), которые инкапсулируют соединение с сервером IMAP4 и реализуют большой подмножество клиентского протокола IMAP4rev1, определённого в [**RFC 2060**](https://python-all.ru/3.2/library/imaplib.html). Он обратно совместим с серверами IMAP4 ([**RFC 1730**](https://python-all.ru/3.2/library/imaplib.html)), но следует учесть, что команда `STATUS` в IMAP4 не поддерживается.1415Модуль [`imaplib`](https://python-all.ru/3.2/library/imaplib.html#module-imaplib) предоставляет три класса; [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4) – базовый класс:1617#### `class imaplib.IMAP4(host='', port=IMAP4_PORT)`1819Этот класс реализует протокол IMAP4. Соединение создается, а версия протокола (IMAP4 или IMAP4rev1) определяется при инициализации экземпляра. Если *host* не указан, используется `''` (локальный хост). Если *port* опущен, используется стандартный порт IMAP4 (143).2021Три исключения определены как атрибуты класса [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4):2223#### `exception IMAP4.error`2425Исключение возникает при любых ошибках. Причина исключения передаётся конструктору в виде строки.2627#### `exception IMAP4.abort`2829Ошибки сервера IMAP4 вызывают это исключение. Оно является подклассом [`IMAP4.error`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4.error). Обратите внимание, что закрытие экземпляра и создание нового обычно позволяет восстановиться после этого исключения.3031#### `exception IMAP4.readonly`3233Это исключение возникает, когда сервер изменяет статус почтового ящика, доступного для записи. Оно является подклассом [`IMAP4.error`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4.error). Теперь какой-то другой клиент имеет права на запись, и для повторного получения прав на запись потребуется открыть ящик заново.3435Также существует подкласс для безопасных соединений:3637#### `class imaplib.IMAP4_SSL(host='', port=IMAP4_SSL_PORT, keyfile=None, certfile=None)`3839Это подкласс [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4), который подключается через SSL-шифрованный сокет (для использования этого класса нужен модуль socket, скомпилированный с поддержкой SSL). Если *host* не указан, используется `''` (локальный хост). Если *port* опущен, используется стандартный IMAP4-over-SSL порт (993). *keyfile* и *certfile* также необязательны – они могут содержать PEM-форматированный закрытый ключ и файл цепочки сертификатов для SSL-соединения.4041Второй подкласс предназначен для соединений, создаваемых дочерним процессом:4243#### `class imaplib.IMAP4_stream(command)`4445Это подкласс, производный от [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4), который подключается к файловым дескрипторам `stdin/stdout`, созданным передачей *command* в `subprocess.Popen()`.4647Определены следующие вспомогательные функции:4849#### `imaplib.Internaldate2tuple(datestr)`5051Разбирает строку IMAP4 `INTERNALDATE` и возвращает соответствующее местное время. Возвращаемое значение – кортеж [`time.struct_time`](https://python-all.ru/3.2/library/time.html#time.struct_time) или None, если строка имеет неверный формат.5253#### `imaplib.Int2AP(num)`5455Преобразует целое число в строковое представление, используя символы из набора \[`A` .. `P`\].5657#### `imaplib.ParseFlags(flagstr)`5859Преобразует ответ IMAP4 `FLAGS` в кортеж отдельных флагов.6061#### `imaplib.Time2Internaldate(date_time)`6263Преобразует *date\_time* в представление IMAP4 `INTERNALDATE`. Возвращаемое значение – строка вида: `"DD-Mmm-YYYY HH:MM:SS +HHMM"` (включая двойные кавычки). Аргумент *date\_time* может быть числом (int или float), представляющим секунды с начала эпохи (как возвращает [`time.time()`](https://python-all.ru/3.2/library/time.html#time.time)), 9-кортежем, представляющим местное время (как возвращает [`time.localtime()`](https://python-all.ru/3.2/library/time.html#time.localtime)), или строкой в двойных кавычках. В последнем случае считается, что строка уже имеет правильный формат.6465Обратите внимание, что номера сообщений IMAP4 изменяются при изменении почтового ящика; в частности, после выполнения команды `EXPUNGE`, удаляющей сообщения, оставшиеся сообщения перенумеровываются. Поэтому настоятельно рекомендуется использовать UID с командой UID.6667В конце модуля есть тестовый раздел, содержащий более полный пример использования.6869> **См. также**70>71> Документы, описывающие протокол, а также исходные коды и бинарные сборки для серверов, реализующих его, можно найти в *IMAP Information Center* Вашингтонского университета ([http://www.washington.edu/imap/](https://python-all.ru/3.2/library/imaplib.html)).7273## 20.13.1. Объекты IMAP47475Все команды IMAP4rev1 представлены методами с теми же именами, в верхнем или нижнем регистре.7677Все аргументы команд преобразуются в строки, за исключением `AUTHENTICATE` и последнего аргумента `APPEND`, который передаётся как литерал IMAP4. При необходимости (если строка содержит символы, чувствительные к протоколу IMAP4, и не заключена в круглые скобки или двойные кавычки) каждая строка заключается в кавычки. Однако аргумент *password* команды `LOGIN` всегда заключается в кавычки. Если требуется избежать заключения строки аргумента в кавычки (например, аргумент *flags* команды `STORE`), то заключите строку в круглые скобки (например: `r'(\Deleted)'`).7879Каждая команда возвращает кортеж: `(type, [data, ...])`, где *type* обычно равно `'OK'` или `'NO'`, а *data* – это либо текст ответа команды, либо обязательные результаты команды. Каждый *data* – это строка или кортеж. Если это кортеж, то первая часть – заголовок ответа, а вторая часть содержит данные (т.е. «литеральное» значение).8081Параметр *message\_set* в командах ниже – это строка, задающая одно или несколько сообщений, над которыми нужно выполнить действие. Это может быть простой номер сообщения (`'1'`), диапазон номеров сообщений (`'2:4'`) или группа несмежных диапазонов, разделённых запятыми (`'1:3,6:9'`). Диапазон может содержать звёздочку для обозначения бесконечной верхней границы (`'3:*'`).8283Экземпляр [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4) имеет следующие методы:8485#### `IMAP4.append(mailbox, flags, date_time, message)`8687Добавляет *message* в указанный почтовый ящик.8889#### `IMAP4.authenticate(mechanism, authobject)`9091Команда аутентификации – требуется обработка ответа.9293*mechanism* указывает, какой механизм аутентификации следует использовать; он должен присутствовать в переменной экземпляра `capabilities` в форме `AUTH=mechanism`.9495*authobject* должен быть вызываемым объектом:9697```python98data = authobject(response)99```100101Он будет вызван для обработки ответов продолжения сервера; переданный ему аргумент *response* будет `bytes`. Он должен возвращать `bytes` *data*, которые будут закодированы в base64 и отправлены на сервер. Он должен вернуть `None`, если вместо этого необходимо отправить ответ об отмене клиента `*`.102103#### `IMAP4.check()`104105Контрольная точка почтового ящика на сервере.106107#### `IMAP4.close()`108109Закрывает текущий выбранный почтовый ящик. Удаленные сообщения удаляются из доступного для записи почтового ящика. Это рекомендуемая команда перед `LOGOUT`.110111#### `IMAP4.copy(message_set, new_mailbox)`112113Копирует сообщения *message\_set* в конец *new\_mailbox*.114115#### `IMAP4.create(mailbox)`116117Создаёт новый почтовый ящик с именем *mailbox*.118119#### `IMAP4.delete(mailbox)`120121Удаляет старый почтовый ящик с именем *mailbox*.122123#### `IMAP4.deleteacl(mailbox, who)`124125Удалить ACL (убрать все права), установленные для who на mailbox.126127#### `IMAP4.expunge()`128129Окончательно удаляет удаленные сообщения из выбранного почтового ящика. Генерирует ответ `EXPUNGE` для каждого удаленного сообщения. Возвращаемые данные содержат список номеров сообщений `EXPUNGE` в порядке получения.130131#### `IMAP4.fetch(message_set, message_parts)`132133Извлекает (части) сообщений. *message\_parts* должна быть строкой с именами частей сообщения, заключенными в круглые скобки, например: `"(UID BODY[TEXT])"`. Возвращаемые данные представляют собой кортежи, содержащие конверт и данные части сообщения.134135#### `IMAP4.getacl(mailbox)`136137Получает `ACL` для *mailbox*. Этот метод является нестандартным, но поддерживается сервером `Cyrus`.138139#### `IMAP4.getannotation(mailbox, entry, attribute)`140141Извлекает указанные `ANNOTATION` для *mailbox*. Метод является нестандартным, но поддерживается сервером `Cyrus`.142143#### `IMAP4.getquota(root)`144145Получает использование ресурсов и лимиты `quota` *root*. Этот метод является частью расширения QUOTA IMAP4, определённого в RFC 2087.146147#### `IMAP4.getquotaroot(mailbox)`148149Получает список `quota` `roots` для указанного *mailbox*. Этот метод является частью расширения QUOTA IMAP4, определённого в RFC 2087.150151#### `IMAP4.list([directory[, pattern]])`152153Выводит имена почтовых ящиков в *directory*, соответствующие *pattern*. *directory* по умолчанию равен корневой почтовой папке, а *pattern* по умолчанию соответствует всему. Возвращаемые данные содержат список ответов `LIST`.154155#### `IMAP4.login(user, password)`156157Идентифицирует клиента с помощью пароля в открытом виде. Параметр *password* будет заключён в кавычки.158159#### `IMAP4.login_cram_md5(user, password)`160161Принудительно использует аутентификацию `CRAM-MD5` при идентификации клиента для защиты пароля. Работает только в том случае, если ответ сервера `CAPABILITY` содержит строку `AUTH=CRAM-MD5`.162163#### `IMAP4.logout()`164165Закрывает соединение с сервером. Возвращает ответ сервера `BYE`.166167#### `IMAP4.lsub(directory='""', pattern='*')`168169Выводит список подписанных почтовых ящиков в указанном каталоге, соответствующих шаблону. По умолчанию *directory* – корневой каталог, а *pattern* – любой почтовый ящик. Возвращаемые данные – кортежи из конверта части сообщения и данных.170171#### `IMAP4.myrights(mailbox)`172173Показывает списки управления доступом (ACL) почтового ящика (т.е. права, которые у клиента есть на этот ящик).174175#### `IMAP4.namespace()`176177Возвращает пространства имён IMAP согласно RFC2342.178179#### `IMAP4.noop()`180181Отправляет `NOOP` на сервер.182183#### `IMAP4.open(host, port)`184185Открывает сокет для подключения к порту *порт* на хосте *хост*. Этот метод неявно вызывается конструктором [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4). Объекты соединения, созданные этим методом, будут использоваться в методах `read`, `readline`, `send` и `shutdown`. Этот метод можно переопределить.186187#### `IMAP4.partial(message_num, message_part, start, length)`188189Извлекает усечённую часть сообщения. Возвращаемые данные – кортеж из конверта части сообщения и данных.190191#### `IMAP4.proxyauth(user)`192193Предполагает аутентификацию от имени пользователя *user*. Позволяет авторизованному администратору выполнять прокси-доступ к почтовому ящику любого пользователя.194195#### `IMAP4.read(size)`196197Читает *size* байт с удалённого сервера. Этот метод можно переопределить.198199#### `IMAP4.readline()`200201Читает одну строку с удалённого сервера. Этот метод можно переопределить.202203#### `IMAP4.recent()`204205Запрашивает у сервера обновление. Возвращаемые данные – `None`, если нет новых сообщений, иначе значение ответа `RECENT`.206207#### `IMAP4.rename(oldmailbox, newmailbox)`208209Переименовывает почтовый ящик с именем *oldmailbox* в *newmailbox*.210211#### `IMAP4.response(code)`212213Возвращает данные для ответа *code*, если он получен, или `None`. Возвращает указанный код, а не обычный тип.214215#### `IMAP4.search(charset, criterion[, ...])`216217Ищет в почтовом ящике сообщения, соответствующие критериям. *charset* может быть `None`, в этом случае в запросе к серверу не будет указан `CHARSET`. Протокол IMAP требует указания хотя бы одного критерия; при возврате ошибки сервером будет возбуждено исключение.218219Пример:220221```python222# M – это подключенный экземпляр IMAP4...223typ, msgnums = M.search(None, 'FROM', '"LDJ"')224225# или:226typ, msgnums = M.search(None, '(FROM "LDJ")')227```228229#### `IMAP4.select(mailbox='INBOX', readonly=False)`230231Выбирает почтовый ящик. Возвращаемые данные – количество сообщений в *mailbox* (ответ `EXISTS`). Ящик по умолчанию – *mailbox*, это `'INBOX'`. Если установлен флаг *readonly*, изменения в ящике запрещены.232233#### `IMAP4.send(data)`234235Отправляет `data` на удалённый сервер. Этот метод можно переопределить.236237#### `IMAP4.setacl(mailbox, who, what)`238239Устанавливает `ACL` для *mailbox*. Этот метод является нестандартным, но поддерживается сервером `Cyrus`.240241#### `IMAP4.setannotation(mailbox, entry, attribute[, ...])`242243Устанавливает `ANNOTATION` для *mailbox*. Этот метод является нестандартным, но поддерживается сервером `Cyrus`.244245#### `IMAP4.setquota(root, limits)`246247Устанавливает `quota` ресурса *root* – *limits*. Этот метод является частью расширения QUOTA протокола IMAP4, определённого в RFC 2087.248249#### `IMAP4.shutdown()`250251Закрывает соединение, установленное в `open`. Этот метод неявно вызывается [`IMAP4.logout()`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4.logout). Этот метод можно переопределить.252253#### `IMAP4.socket()`254255Возвращает экземпляр сокета, используемый для подключения к серверу.256257#### `IMAP4.sort(sort_criteria, charset, search_criterion[, ...])`258259Команда `sort` является разновидностью `search` с семантикой сортировки результатов. Возвращаемые данные содержат разделённый пробелами список номеров подходящих сообщений.260261У sort есть два аргумента перед *search\_criterion*: заключённый в скобки список *sort\_criteria* и *charset* для поиска. Обратите внимание: в отличие от `search`, аргумент *charset* является обязательным. Также существует команда `uid sort`, которая соотносится с `sort` так же, как `uid search` соотносится с `search`. Команда `sort` сначала ищет в почтовом ящике сообщения, соответствующие заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях. Затем она возвращает номера подходящих сообщений.262263Это расширенная команда `IMAP4rev1`.264265#### `IMAP4.starttls(ssl_context=None)`266267Отправляет команду `STARTTLS`. Аргумент *ssl\_context* необязателен и должен быть [`ssl.SSLContext`](https://python-all.ru/3.2/library/ssl.html#ssl.SSLContext) объектом. Это включит шифрование на IMAP-соединении.268269Новое в версии 3.2.270271#### `IMAP4.status(mailbox, names)`272273Запрашивает именованные условия состояния для *mailbox*.274275#### `IMAP4.store(message_set, command, flag_list)`276277Изменяет установки флагов для сообщений в почтовом ящике. *command* задаётся разделом 6.4.6 [**RFC 2060**](https://python-all.ru/3.2/library/imaplib.html) и может быть одним из «FLAGS», «+FLAGS» или «-FLAGS», опционально с суффиксом «.SILENT».278279Например, чтобы установить флаг удаления на все сообщения:280281```python282typ, data = M.search(None, 'ALL')283for num in data[0].split():284   M.store(num, '+FLAGS', '\\Deleted')285M.expunge()286```287288#### `IMAP4.subscribe(mailbox)`289290Подписаться на новый почтовый ящик.291292#### `IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])`293294Команда `thread` является вариантом `search` с семантикой threading для результатов. Возвращаемые данные содержат разделённый пробелами список участников threading.295296Участники ветвей состоят из нуля или более номеров сообщений, разделенных пробелами, указывающих последовательные родительские и дочерние элементы.297298Команда thread принимает два аргумента перед аргументом(ами) *search\_criterion*: *threading\_algorithm* и *charset* поиска. Обратите внимание, что в отличие от `search`, аргумент *charset* поиска является обязательным. Также существует команда `uid thread`, которая соответствует `thread` так же, как `uid search` соответствует `search`. Команда `thread` сначала ищет в почтовом ящике сообщения, соответствующие заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях поиска. Затем она возвращает соответствующие сообщения, сгруппированные в соответствии с заданным алгоритмом threading.299300Это расширенная команда `IMAP4rev1`.301302#### `IMAP4.uid(command, arg[, ...])`303304Выполняет команду с аргументами для сообщений, идентифицированных по UID, а не по номеру сообщения. Возвращает ответ, соответствующий команде. Должен быть указан по крайней мере один аргумент; если ни одного не передано, сервер вернет ошибку, и будет возбуждено исключение.305306#### `IMAP4.unsubscribe(mailbox)`307308Отписаться от старого почтового ящика.309310#### `IMAP4.xatom(name[, ...])`311312Разрешает простые расширенные команды, уведомляемые сервером в ответе `CAPABILITY`.313314Следующие атрибуты определены для экземпляров [`IMAP4`](https://python-all.ru/3.2/library/imaplib.html#imaplib.IMAP4):315316#### `IMAP4.PROTOCOL_VERSION`317318Последняя поддерживаемая версия протокола в ответе `CAPABILITY` от сервера.319320#### `IMAP4.debug`321322Целое число для управления отладочным выводом. Начальное значение берётся из модульной переменной `Debug`. Значения больше трёх трассируют каждую команду.323324## 20.13.2. Пример IMAP4325326Вот минимальный пример (без проверки ошибок), который открывает почтовый ящик и извлекает и выводит все сообщения:327328```python329import getpass, imaplib330331M = imaplib.IMAP4()332M.login(getpass.getuser(), getpass.getpass())333M.select()334typ, data = M.search(None, 'ALL')335for num in data[0].split():336    typ, data = M.fetch(num, '(RFC822)')337    print('Message %s\n%s\n' % (num, data[0][1]))338M.close()339M.logout()340```341