`imaplib.md`

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