`imaplib.md`

687 строк · 26.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.0/library/imaplib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `imaplib` – клиент протокола IMAP489Этот модуль определяет три класса: [`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4), [`IMAP4_SSL`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4_SSL) и [`IMAP4_stream`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4_stream), которые инкапсулируют соединение с сервером IMAP4 и реализуют большой подмножество клиентского протокола IMAP4rev1, определённого в [**RFC 2060**](https://python-all.ru/3.0/library/imaplib.html). Он обратно совместим с серверами IMAP4 ([**RFC 1730**](https://python-all.ru/3.0/library/imaplib.html)), но следует учесть, что команда `STATUS` в IMAP4 не поддерживается.1011Модуль `imaplib` предоставляет три класса, [`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4) является базовым классом:1213#### `[imaplib.IMAP4]class imaplib.IMAP4([host[, port]])`1415Этот класс реализует протокол IMAP4. Соединение создается, а версия протокола (IMAP4 или IMAP4rev1) определяется при инициализации экземпляра. Если1617*host*1819не указан, используется2021`''`2223(локальный хост). Если2425*port*2627опущен, используется стандартный порт IMAP4 (143).2829Три исключения определены как атрибуты класса [`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4):3031#### `[imaplib.IMAP4.error]exception IMAP4.error`3233Исключение возникает при любых ошибках. Причина исключения передаётся конструктору в виде строки.3435#### `[imaplib.IMAP4.abort]exception IMAP4.abort`3637Ошибки сервера IMAP4 вызывают это исключение. Оно является подклассом3839[`IMAP4.error`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4.error)4041. Обратите внимание, что закрытие экземпляра и создание нового обычно позволяет восстановиться после этого исключения.4243#### `[imaplib.IMAP4.readonly]exception IMAP4.readonly`4445Это исключение возникает, когда сервер изменяет статус почтового ящика, доступного для записи. Оно является подклассом4647[`IMAP4.error`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4.error)4849. Теперь какой-то другой клиент имеет права на запись, и для повторного получения прав на запись потребуется открыть ящик заново.5051Также существует подкласс для безопасных соединений:5253#### `[imaplib.IMAP4_SSL]class imaplib.IMAP4_SSL([host[, port[, keyfile[, certfile]]]])`5455Это подкласс5657[`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4)5859, который подключается через SSL-шифрованный сокет (для использования этого класса нужен модуль socket, скомпилированный с поддержкой SSL). Если6061*host*6263не указан, используется6465`''`6667(локальный хост). Если6869*port*7071опущен, используется стандартный IMAP4-over-SSL порт (993).7273*keyfile*7475и7677*certfile*7879также необязательны – они могут содержать PEM-форматированный закрытый ключ и файл цепочки сертификатов для SSL-соединения.8081Второй подкласс предназначен для соединений, создаваемых дочерним процессом:8283#### `[imaplib.IMAP4_stream]class imaplib.IMAP4_stream(command)`8485Это подкласс, производный от8687[`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4)8889, который подключается к файловым дескрипторам9091`stdin/stdout`9293, созданным передачей9495*command*9697в9899`subprocess.Popen()`100101.102103Определены следующие вспомогательные функции:104105#### `[imaplib.Internaldate2tuple]imaplib.Internaldate2tuple(datestr)`106107Преобразует строку INTERNALDATE IMAP4 во всемирное координированное время. Возвращает кортеж модуля108109[`time`](https://python-all.ru/3.0/library/time.html#module-time)110111.112113#### `[imaplib.Int2AP]imaplib.Int2AP(num)`114115Преобразует целое число в строковое представление, используя символы из набора \[116117`A`118119..120121`P`122123\].124125#### `[imaplib.ParseFlags]imaplib.ParseFlags(flagstr)`126127Преобразует ответ IMAP4128129`FLAGS`130131в кортеж отдельных флагов.132133#### `[imaplib.Time2Internaldate]imaplib.Time2Internaldate(date_time)`134135Преобразует кортеж модуля136137[`time`](https://python-all.ru/3.0/library/time.html#module-time)138139в представление IMAP4140141`INTERNALDATE`142143. Возвращает строку вида:144145`"DD-Mmm-YYYY HH:MM:SS +HHMM"`146147(включая dвойные кавычки).148149Обратите внимание, что номера сообщений IMAP4 изменяются при изменении почтового ящика; в частности, после выполнения команды `EXPUNGE`, удаляющей сообщения, оставшиеся сообщения перенумеровываются. Поэтому настоятельно рекомендуется использовать UID с командой UID.150151В конце модуля есть тестовый раздел, содержащий более полный пример использования.152153> **См. также**154>155> Документы, описывающие протокол, а также исходные коды и бинарные сборки для серверов, реализующих его, можно найти в *IMAP Information Center* Вашингтонского университета ([http://www.washington.edu/imap/](https://python-all.ru/3.0/library/imaplib.html)).156157## Объекты IMAP4158159Все команды IMAP4rev1 представлены методами с теми же именами, в верхнем или нижнем регистре.160161Все аргументы команд преобразуются в строки, за исключением `AUTHENTICATE` и последнего аргумента `APPEND`, который передаётся как литерал IMAP4. При необходимости (если строка содержит символы, чувствительные к протоколу IMAP4, и не заключена в круглые скобки или двойные кавычки) каждая строка заключается в кавычки. Однако аргумент *password* команды `LOGIN` всегда заключается в кавычки. Если требуется избежать заключения строки аргумента в кавычки (например, аргумент *flags* команды `STORE`), то заключите строку в круглые скобки (например: `r'(\Deleted)'`).162163Каждая команда возвращает кортеж: `(type, [data, ...])`, где *type* обычно равно `'OK'` или `'NO'`, а *data* – это либо текст ответа команды, либо обязательные результаты команды. Каждый *data* – это строка или кортеж. Если это кортеж, то первая часть – заголовок ответа, а вторая часть содержит данные (т.е. «литеральное» значение).164165Параметр *message\_set* в командах ниже – это строка, задающая одно или несколько сообщений, над которыми нужно выполнить действие. Это может быть простой номер сообщения (`'1'`), диапазон номеров сообщений (`'2:4'`) или группа несмежных диапазонов, разделённых запятыми (`'1:3,6:9'`). Диапазон может содержать звёздочку для обозначения бесконечной верхней границы (`'3:*'`).166167Экземпляр [`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4) имеет следующие методы:168169#### `[imaplib.IMAP4.append]IMAP4.append(mailbox, flags, date_time, message)`170171Добавляет172173*message*174175в указанный почтовый ящик.176177#### `[imaplib.IMAP4.authenticate]IMAP4.authenticate(mechanism, authobject)`178179Команда аутентификации – требуется обработка ответа.180181*mechanism* указывает, какой механизм аутентификации следует использовать; он должен присутствовать в переменной экземпляра `capabilities` в форме `AUTH=mechanism`.182183*authobject* должен быть вызываемым объектом:184185```python186data = authobject(response)187```188189Она будет вызвана для обработки серверных ответов продолжения. Она должна возвращать `data`, которые будут закодированы и отправлены на сервер. Она должна возвращать `None`, если вместо этого должен быть отправлен ответ `*` об отмене клиентом.190191#### `[imaplib.IMAP4.check]IMAP4.check()`192193Контрольная точка почтового ящика на сервере.194195#### `[imaplib.IMAP4.close]IMAP4.close()`196197Закрывает текущий выбранный почтовый ящик. Удаленные сообщения удаляются из доступного для записи почтового ящика. Это рекомендуемая команда перед198199`LOGOUT`200201.202203#### `[imaplib.IMAP4.copy]IMAP4.copy(message_set, new_mailbox)`204205Копирует сообщения206207*message\_set*208209в конец210211*new\_mailbox*212213.214215#### `[imaplib.IMAP4.create]IMAP4.create(mailbox)`216217Создаёт новый почтовый ящик с именем218219*mailbox*220221.222223#### `[imaplib.IMAP4.delete]IMAP4.delete(mailbox)`224225Удаляет старый почтовый ящик с именем226227*mailbox*228229.230231#### `[imaplib.IMAP4.deleteacl]IMAP4.deleteacl(mailbox, who)`232233Удалить ACL (убрать все права), установленные для who на mailbox.234235#### `[imaplib.IMAP4.expunge]IMAP4.expunge()`236237Окончательно удаляет удаленные сообщения из выбранного почтового ящика. Генерирует ответ238239`EXPUNGE`240241для каждого удаленного сообщения. Возвращаемые данные содержат список номеров сообщений242243`EXPUNGE`244245в порядке получения.246247#### `[imaplib.IMAP4.fetch]IMAP4.fetch(message_set, message_parts)`248249Извлекает (части) сообщений.250251*message\_parts*252253должна быть строкой с именами частей сообщения, заключенными в круглые скобки, например:254255`"(UID BODY[TEXT])"`256257. Возвращаемые данные представляют собой кортежи, содержащие конверт и данные части сообщения.258259#### `[imaplib.IMAP4.getacl]IMAP4.getacl(mailbox)`260261Получает262263`ACL`264265для266267*mailbox*268269. Этот метод является нестандартным, но поддерживается сервером270271`Cyrus`272273.274275#### `[imaplib.IMAP4.getannotation]IMAP4.getannotation(mailbox, entry, attribute)`276277Извлекает указанные278279`ANNOTATION`280281для282283*mailbox*284285. Метод является нестандартным, но поддерживается сервером286287`Cyrus`288289.290291#### `[imaplib.IMAP4.getquota]IMAP4.getquota(root)`292293Получает использование ресурсов и лимиты294295`quota`296297*root*298299. Этот метод является частью расширения QUOTA IMAP4, определённого в RFC 2087.300301#### `[imaplib.IMAP4.getquotaroot]IMAP4.getquotaroot(mailbox)`302303Получает список304305`quota`306307`roots`308309для указанного310311*mailbox*312313. Этот метод является частью расширения QUOTA IMAP4, определённого в RFC 2087.314315#### `[imaplib.IMAP4.list]IMAP4.list([directory[, pattern]])`316317Выводит имена почтовых ящиков в318319*directory*320321, соответствующие322323*pattern*324325.326327*directory*328329по умолчанию равен корневой почтовой папке, а330331*pattern*332333по умолчанию соответствует всему. Возвращаемые данные содержат список ответов334335`LIST`336337.338339#### `[imaplib.IMAP4.login]IMAP4.login(user, password)`340341Идентифицирует клиента с помощью пароля в открытом виде. Параметр342343*password*344345будет заключён в кавычки.346347#### `[imaplib.IMAP4.login_cram_md5]IMAP4.login_cram_md5(user, password)`348349Принудительно использует аутентификацию350351`CRAM-MD5`352353при идентификации клиента для защиты пароля. Работает только в том случае, если ответ сервера354355`CAPABILITY`356357содержит строку358359`AUTH=CRAM-MD5`360361.362363#### `[imaplib.IMAP4.logout]IMAP4.logout()`364365Закрывает соединение с сервером. Возвращает ответ сервера366367`BYE`368369.370371#### `[imaplib.IMAP4.lsub]IMAP4.lsub([directory[, pattern]])`372373Выводит список подписанных почтовых ящиков в указанном каталоге, соответствующих шаблону. По умолчанию374375*directory*376377– корневой каталог, а378379*pattern*380381– любой почтовый ящик. Возвращаемые данные – кортежи из конверта части сообщения и данных.382383#### `[imaplib.IMAP4.myrights]IMAP4.myrights(mailbox)`384385Показывает списки управления доступом (ACL) почтового ящика (т.е. права, которые у клиента есть на этот ящик).386387#### `[imaplib.IMAP4.namespace]IMAP4.namespace()`388389Возвращает пространства имён IMAP согласно RFC2342.390391#### `[imaplib.IMAP4.noop]IMAP4.noop()`392393Отправляет394395`NOOP`396397на сервер.398399#### `[imaplib.IMAP4.open]IMAP4.open(host, port)`400401Открывает сокет на402403*port*404405на406407*host*408409. Объекты соединения, установленные этим методом, будут использоваться в методах410411`read`412413,414415`readline`416417,418419`send`420421и422423`shutdown`424425. Этот метод можно переопределить.426427#### `[imaplib.IMAP4.partial]IMAP4.partial(message_num, message_part, start, length)`428429Извлекает усечённую часть сообщения. Возвращаемые данные – кортеж из конверта части сообщения и данных.430431#### `[imaplib.IMAP4.proxyauth]IMAP4.proxyauth(user)`432433Предполагает аутентификацию от имени пользователя434435*user*436437. Позволяет авторизованному администратору выполнять прокси-доступ к почтовому ящику любого пользователя.438439#### `[imaplib.IMAP4.read]IMAP4.read(size)`440441Читает442443*size*444445байт с удалённого сервера. Этот метод можно переопределить.446447#### `[imaplib.IMAP4.readline]IMAP4.readline()`448449Читает одну строку с удалённого сервера. Этот метод можно переопределить.450451#### `[imaplib.IMAP4.recent]IMAP4.recent()`452453Запрашивает у сервера обновление. Возвращаемые данные –454455`None`456457, если нет новых сообщений, иначе значение ответа458459`RECENT`460461.462463#### `[imaplib.IMAP4.rename]IMAP4.rename(oldmailbox, newmailbox)`464465Переименовывает почтовый ящик с именем466467*oldmailbox*468469в470471*newmailbox*472473.474475#### `[imaplib.IMAP4.response]IMAP4.response(code)`476477Возвращает данные для ответа478479*code*480481, если он получен, или482483`None`484485. Возвращает указанный код, а не обычный тип.486487#### `[imaplib.IMAP4.search]IMAP4.search(charset, criterion[, ...])`488489Ищет в почтовом ящике сообщения, соответствующие критериям. *charset* может быть `None`, в этом случае в запросе к серверу не будет указан `CHARSET`. Протокол IMAP требует указания хотя бы одного критерия; при возврате ошибки сервером будет возбуждено исключение.490491Пример:492493```python494# M – это подключенный экземпляр IMAP4...495typ, msgnums = M.search(None, 'FROM', '"LDJ"')496497# или:498typ, msgnums = M.search(None, '(FROM "LDJ")')499```500501#### `[imaplib.IMAP4.select]IMAP4.select([mailbox[, readonly]])`502503Выбирает почтовый ящик. Возвращаемые данные – количество сообщений в504505*mailbox*506507(ответ508509`EXISTS`510511). Ящик по умолчанию –512513*mailbox*514515, это516517`'INBOX'`518519. Если установлен флаг520521*readonly*522523, изменения в ящике запрещены.524525#### `[imaplib.IMAP4.send]IMAP4.send(data)`526527Отправляет528529`data`530531на удалённый сервер. Этот метод можно переопределить.532533#### `[imaplib.IMAP4.setacl]IMAP4.setacl(mailbox, who, what)`534535Устанавливает536537`ACL`538539для540541*mailbox*542543. Этот метод является нестандартным, но поддерживается сервером544545`Cyrus`546547.548549#### `[imaplib.IMAP4.setannotation]IMAP4.setannotation(mailbox, entry, attribute[, ...])`550551Устанавливает552553`ANNOTATION`554555для556557*mailbox*558559. Этот метод является нестандартным, но поддерживается сервером560561`Cyrus`562563.564565#### `[imaplib.IMAP4.setquota]IMAP4.setquota(root, limits)`566567Устанавливает568569`quota`570571ресурса572573*root*574575–576577*limits*578579. Этот метод является частью расширения QUOTA протокола IMAP4, определённого в RFC 2087.580581#### `[imaplib.IMAP4.shutdown]IMAP4.shutdown()`582583Закрывает соединение, установленное в584585`open`586587. Этот метод можно переопределить.588589#### `[imaplib.IMAP4.socket]IMAP4.socket()`590591Возвращает экземпляр сокета, используемый для подключения к серверу.592593#### `[imaplib.IMAP4.sort]IMAP4.sort(sort_criteria, charset, search_criterion[, ...])`594595Команда `sort` является разновидностью `search` с семантикой сортировки результатов. Возвращаемые данные содержат разделённый пробелами список номеров подходящих сообщений.596597У sort есть два аргумента перед *search\_criterion*: заключённый в скобки список *sort\_criteria* и *charset* для поиска. Обратите внимание: в отличие от `search`, аргумент *charset* является обязательным. Также существует команда `uid sort`, которая соотносится с `sort` так же, как `uid search` соотносится с `search`. Команда `sort` сначала ищет в почтовом ящике сообщения, соответствующие заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях. Затем она возвращает номера подходящих сообщений.598599Это расширенная команда `IMAP4rev1`.600601#### `[imaplib.IMAP4.status]IMAP4.status(mailbox, names)`602603Запрашивает именованные условия состояния для604605*mailbox*606607.608609#### `[imaplib.IMAP4.store]IMAP4.store(message_set, command, flag_list)`610611Изменяет состояния флагов для сообщений в почтовом ящике. Параметр *command* задаётся в разделе 6.4.6 документа [**RFC 2060**](https://python-all.ru/3.0/library/imaplib.html) как одно из значений «FLAGS», «+FLAGS» или «-FLAGS», возможно с суффиксом «.SILENT».612613Например, чтобы установить флаг удаления на все сообщения:614615```python616typ, data = M.search(None, 'ALL')617for num in data[0].split():618   M.store(num, '+FLAGS', '\\Deleted')619M.expunge()620```621622#### `[imaplib.IMAP4.subscribe]IMAP4.subscribe(mailbox)`623624Подписаться на новый почтовый ящик.625626#### `[imaplib.IMAP4.thread]IMAP4.thread(threading_algorithm, charset, search_criterion[, ...])`627628Команда `thread` является вариантом `search` с семантикой threading для результатов. Возвращаемые данные содержат разделённый пробелами список участников threading.629630Участники ветвей состоят из нуля или более номеров сообщений, разделенных пробелами, указывающих последовательные родительские и дочерние элементы.631632Команда thread принимает два аргумента перед аргументом(ами) *search\_criterion*: *threading\_algorithm* и *charset* поиска. Обратите внимание, что в отличие от `search`, аргумент *charset* поиска является обязательным. Также существует команда `uid thread`, которая соответствует `thread` так же, как `uid search` соответствует `search`. Команда `thread` сначала ищет в почтовом ящике сообщения, соответствующие заданным критериям поиска, используя аргумент charset для интерпретации строк в критериях поиска. Затем она возвращает соответствующие сообщения, сгруппированные в соответствии с заданным алгоритмом threading.633634Это расширенная команда `IMAP4rev1`.635636#### `[imaplib.IMAP4.uid]IMAP4.uid(command, arg[, ...])`637638Выполняет команду с аргументами для сообщений, идентифицированных по UID, а не по номеру сообщения. Возвращает ответ, соответствующий команде. Должен быть указан по крайней мере один аргумент; если ни одного не передано, сервер вернет ошибку, и будет возбуждено исключение.639640#### `[imaplib.IMAP4.unsubscribe]IMAP4.unsubscribe(mailbox)`641642Отписаться от старого почтового ящика.643644#### `[imaplib.IMAP4.xatom]IMAP4.xatom(name[, arg[, ...]])`645646Разрешает простые расширенные команды, уведомляемые сервером в ответе647648`CAPABILITY`649650.651652Следующие атрибуты определены для экземпляров [`IMAP4`](https://python-all.ru/3.0/library/imaplib.html#imaplib.IMAP4):653654#### `[imaplib.IMAP4.PROTOCOL_VERSION]IMAP4.PROTOCOL_VERSION`655656Последняя поддерживаемая версия протокола в ответе657658`CAPABILITY`659660от сервера.661662#### `[imaplib.IMAP4.debug]IMAP4.debug`663664Целое число для управления отладочным выводом. Начальное значение берётся из модульной переменной665666`Debug`667668. Значения больше трёх трассируют каждую команду.669670## Пример IMAP4671672Вот минимальный пример (без проверки ошибок), который открывает почтовый ящик и извлекает и выводит все сообщения:673674```python675import getpass, imaplib676677M = imaplib.IMAP4()678M.login(getpass.getuser(), getpass.getpass())679M.select()680typ, data = M.search(None, 'ALL')681for num in data[0].split():682    typ, data = M.fetch(num, '(RFC822)')683    print('Message %s\n%s\n' % (num, data[0][1]))684M.close()685M.logout()686```687