`mailbox.md`

1024 строк · 96.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/library/mailbox.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `mailbox` – Управление почтовыми ящиками в различных форматах89**Исходный код:** [Lib/mailbox.py](https://python-all.ru/src/3.14/Lib/mailbox.py)1011---1213Этот модуль определяет два класса: [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) и [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message) для доступа к почтовым ящикам на диске и управления ими, а также для работы с содержащимися в них сообщениями. `Mailbox` предоставляет словареподобное отображение ключей на сообщения. `Message` расширяет класс [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) из модуля [`email.message`](https://python-all.ru/3/library/email.message.html#module-email.message), добавляя формат-специфичное состояние и поведение. Поддерживаемые форматы почтовых ящиков: Maildir, mbox, MH, Babyl и MMDF.1415> **См. также**16>17> **Модуль [`email`](https://python-all.ru/3/library/email.html#module-email)**18>19> Представление сообщений и управление ими.2021## `Mailbox` объекты2223#### `class mailbox.Mailbox`2425Почтовый ящик, который можно просматривать и изменять.2627Класс `Mailbox` определяет интерфейс и не предназначен для создания экземпляров. Вместо этого следует наследовать формат-специфичные подклассы от `Mailbox`, а код должен создавать экземпляры конкретного подкласса.2829Интерфейс `Mailbox` напоминает словарь: небольшие ключи соответствуют сообщениям. Ключи выдаются экземпляром `Mailbox`, с которым они будут использоваться, и имеют смысл только для этого экземпляра `Mailbox`. Ключ продолжает идентифицировать сообщение, даже если соответствующее сообщение изменяется, например, заменяется другим сообщением.3031Сообщения можно добавлять в экземпляр `Mailbox` с помощью метода [`add()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.add) (подобного set) и удалять с помощью инструкции `del` или методов [`remove()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.remove) и [`discard()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.discard) (также подобных set).3233Семантика интерфейса `Mailbox` отличается от семантики словаря в некоторых важных аспектах. При каждом запросе сообщения на основе текущего состояния почтового ящика создаётся новое представление (обычно экземпляр [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message)). Аналогично, при добавлении сообщения в экземпляр `Mailbox` содержимое переданного представления сообщения копируется. Ни в одном из случаев экземпляр `Mailbox` не сохраняет ссылку на представление сообщения.3435По умолчанию `Mailbox` [итератор](https://python-all.ru/3/glossary.html#term-iterator) выполняет итерацию по представлениям сообщений, а не по ключам, как это делает итератор [`dictionary`](https://python-all.ru/3/library/stdtypes.html#dict) по умолчанию. Более того, изменение почтового ящика во время итерации безопасно и имеет чётко определённое поведение. Сообщения, добавленные в почтовый ящик после создания итератора, не будут видны итератору. Сообщения, удалённые из почтового ящика до того, как итератор их вернёт, будут молча пропущены, хотя использование ключа от итератора может привести к исключению [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если соответствующее сообщение впоследствии будет удалено.3637> **Предупреждение**38>39> Будьте очень осторожны при изменении почтовых ящиков, которые могут одновременно изменяться другим процессом. Самый безопасный формат почтового ящика для таких задач – [`Maildir`](https://python-all.ru/3/library/mailbox.html#mailbox.Maildir); старайтесь избегать использования однофайловых форматов, таких как [`mbox`](https://python-all.ru/3/library/mailbox.html#mailbox.mbox), для одновременной записи. Если вы изменяете почтовый ящик, вы *должны* заблокировать его, вызвав методы [`lock()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.lock) и [`unlock()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.unlock) *перед* чтением любых сообщений в файле или внесением любых изменений (добавлением или удалением сообщения). Неблокировка почтового ящика чревата потерей сообщений или повреждением всего почтового ящика.4041Экземпляры `Mailbox` имеют следующие методы:4243#### `add(message)`4445Добавляет *сообщение* в почтовый ящик и возвращает ключ, который был ему присвоен.4647Параметр *message* может быть экземпляром [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message), строкой, байтовой строкой или файлоподобным объектом (который должен быть открыт в двоичном режиме). Если *message* является экземпляром соответствующего формат-специфичного подкласса `Message` (например, если это экземпляр [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage), а это экземпляр [`mbox`](https://python-all.ru/3/library/mailbox.html#mailbox.mbox)), используется его формат-специфичная информация. В противном случае используются разумные значения по умолчанию для формат-специфичной информации.4849Изменено в версии 3.2: Добавлена поддержка двоичного ввода.5051#### `remove(key)`5253#### `__delitem__(key)`5455#### `discard(key)`5657Удаляет сообщение, соответствующее *ключу*, из почтового ящика.5859Если такого сообщения не существует, возникает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если метод был вызван как `remove()` или `__delitem__()`, но исключение не возникает, если метод был вызван как `discard()`. Поведение `discard()` может быть предпочтительнее, если базовый формат почтового ящика поддерживает одновременное изменение другими процессами.6061#### `__setitem__(key, message)`6263Заменяет сообщение, соответствующее *ключу*, на *сообщение*. Возникает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если *ключу* ещё не соответствует ни одно сообщение.6465Как и в случае с [`add()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.add), параметр *message* может быть экземпляром [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message), строкой, байтовой строкой или файлоподобным объектом (который должен быть открыт в двоичном режиме). Если *message* является экземпляром соответствующего формат-специфичного подкласса `Message` (например, если это экземпляр [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage), а это экземпляр [`mbox`](https://python-all.ru/3/library/mailbox.html#mailbox.mbox)), используется его формат-специфичная информация. В противном случае формат-специфичная информация сообщения, которое в данный момент соответствует *ключу*, остаётся неизменной.6667#### `iterkeys()`6869Возвращает [итератор](https://python-all.ru/3/glossary.html#term-iterator) по всем ключам7071#### `keys()`7273То же, что и [`iterkeys()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.iterkeys), за исключением того, что возвращается [`list`](https://python-all.ru/3/library/stdtypes.html#list), а не [итератор](https://python-all.ru/3/glossary.html#term-iterator)7475#### `itervalues()`7677#### `__iter__()`7879Возвращает [итератор](https://python-all.ru/3/glossary.html#term-iterator) по представлениям всех сообщений. Сообщения представлены в виде экземпляров соответствующего формат-специфичного подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра `Mailbox` не была указана пользовательская фабрика сообщений.8081> **Примечание**82>83> Поведение `__iter__()` отличается от поведения словарей, которые перебирают ключи.8485#### `values()`8687То же, что и [`itervalues()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.itervalues), за исключением того, что возвращается [`list`](https://python-all.ru/3/library/stdtypes.html#list) вместо [итератора](https://python-all.ru/3/glossary.html#term-iterator)8889#### `iteritems()`9091Возвращает [итератор](https://python-all.ru/3/glossary.html#term-iterator) по парам (*ключ*, *сообщение*), где *ключ* – это ключ, а *сообщение* – представление сообщения. Сообщения представлены в виде экземпляров соответствующего подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра `Mailbox` не была указана пользовательская фабрика сообщений.9293#### `items()`9495То же, что и [`iteritems()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.iteritems), за исключением того, что возвращается [`list`](https://python-all.ru/3/library/stdtypes.html#list) пар вместо [итератора](https://python-all.ru/3/glossary.html#term-iterator) пар.9697#### `get(key, default=None)`9899#### `__getitem__(key)`100101Возвращает представление сообщения, соответствующего *ключу*. Если такого сообщения нет, *default* возвращается, если метод был вызван как `get()`, и вызывается исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если метод был вызван как `__getitem__()`. Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра `Mailbox` не была указана пользовательская фабрика сообщений.102103#### `get_message(key)`104105Возвращает представление сообщения, соответствующего *ключу*, в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), или вызывает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если такого сообщения нет.106107#### `get_bytes(key)`108109Возвращает байтовое представление сообщения, соответствующего *ключу*, или вызывает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если такого сообщения нет.110111Добавлено в версии 3.2.112113#### `get_string(key)`114115Возвращает строковое представление сообщения, соответствующего *ключу*, или вызывает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если такого сообщения нет. Сообщение обрабатывается через [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message) для преобразования в 7-битное чистое представление.116117#### `get_file(key)`118119Возвращает [файлоподобное](https://python-all.ru/3/glossary.html#term-file-like-object) представление сообщения, соответствующего *ключу*, или вызывает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), если такого сообщения нет. Файлоподобный объект ведёт себя так, как если бы он был открыт в двоичном режиме. Этот файл следует закрыть, когда он больше не нужен.120121Изменено в версии 3.2: Объект файла теперь действительно является [двоичным файлом](https://python-all.ru/3/glossary.html#term-binary-file); ранее он ошибочно возвращался в текстовом режиме. Кроме того, [файлоподобный объект](https://python-all.ru/3/glossary.html#term-file-like-object) теперь поддерживает протокол [менеджера контекста](https://python-all.ru/3/glossary.html#term-context-manager): можно использовать оператор [`with`](https://python-all.ru/3/reference/compound_stmts.html#with) для автоматического закрытия.122123> **Примечание**124>125> В отличие от других представлений сообщений, [файлоподобные](https://python-all.ru/3/glossary.html#term-file-like-object) представления не обязательно независимы от экземпляра `Mailbox`, который их создал, или от базового почтового ящика. Более подробная документация предоставляется каждым подклассом.126127#### `__contains__(key)`128129Возвращает `True`, если *ключ* соответствует сообщению, и `False` в противном случае.130131#### `__len__()`132133Возвращает количество сообщений в почтовом ящике.134135#### `clear()`136137Удаляет все сообщения из почтового ящика.138139#### `pop(key, default=None)`140141Возвращает представление сообщения, соответствующего *ключу*, и удаляет сообщение. Если такого сообщения нет, возвращает *default*. Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра `Mailbox` не была указана пользовательская фабрика сообщений.142143#### `popitem()`144145Возвращает произвольную пару (*ключ*, *сообщение*), где *ключ* – это ключ, а *сообщение* – представление сообщения, и удаляет соответствующее сообщение. Если почтовый ящик пуст, вызывает исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError). Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра `Mailbox` не была указана пользовательская фабрика сообщений.146147#### `update(arg)`148149Параметр *arg* должен быть отображением *ключ* → *сообщение* или итерируемым объектом из пар (*ключ*, *сообщение*). Обновляет почтовый ящик так, что для каждой заданной пары *ключ* и *сообщение* сообщение, соответствующее *ключу*, устанавливается в *сообщение* как если бы с помощью [`__setitem__()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.__setitem__). Как и в случае с `__setitem__()`, каждый *ключ* уже должен соответствовать сообщению в почтовом ящике, иначе будет вызвано исключение [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError), поэтому в общем случае неправильно, чтобы *arg* был экземпляром `Mailbox`.150151> **Примечание**152>153> В отличие от словарей, именованные аргументы не поддерживаются.154155#### `flush()`156157Записывает все ожидающие изменения в файловую систему. Для некоторых подклассов `Mailbox` изменения всегда записываются сразу, и `flush()` ничего не делает, но всё же стоит выработать привычку вызывать этот метод.158159#### `lock()`160161Устанавливает исключительную рекомендательную блокировку на почтовый ящик, чтобы другие процессы знали, что его не следует изменять. Если блокировка недоступна, возбуждается исключение [`ExternalClashError`](https://python-all.ru/3/library/mailbox.html#mailbox.ExternalClashError). Конкретные механизмы блокировки зависят от формата почтового ящика. Перед любыми изменениями содержимого следует *всегда* блокировать почтовый ящик.162163#### `unlock()`164165Освобождает блокировку почтового ящика, если она установлена.166167#### `close()`168169Сбрасывает почтовый ящик, при необходимости снимает блокировку и закрывает все открытые файлы. Для некоторых подклассов `Mailbox` этот метод ничего не делает.170171### `Maildir` объекты172173#### `class mailbox.Maildir(dirname, factory=None, create=True)`174175Подкласс [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате Maildir. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.176177Если *create* равно `True` и путь *dirname* существует, он будет рассматриваться как существующий maildir без попытки проверки структуры его каталогов.178179По историческим причинам *dirname* назван так, а не *path*.180181Maildir – это почтовый формат на основе каталогов, разработанный для агента передачи почты qmail и ныне широко поддерживаемый другими программами. Сообщения в почтовом ящике Maildir хранятся в отдельных файлах в общей структуре каталогов. Такая архитектура позволяет нескольким независимым программам получать доступ и изменять почтовые ящики Maildir без повреждения данных, поэтому файловая блокировка не требуется.182183Почтовые ящики Maildir содержат три подкаталога: `tmp`, `new` и `cur`. Сообщения создаются в подкаталоге `tmp`, а затем перемещаются в подкаталог `new` для завершения доставки. После этого почтовый клиент может переместить сообщение в подкаталог `cur` и сохранить информацию о состоянии сообщения в специальном разделе «info», добавляемом к его имени файла.184185Также поддерживаются папки в стиле, введённом агентом передачи почты Courier. Любой подкаталог основного почтового ящика считается папкой, если первым символом в его имени является `'.'`. Имена папок представляются как `Maildir` без ведущего `'.'`. Каждая папка сама является почтовым ящиком Maildir, но не должна содержать другие папки. Вместо этого логическая вложенность указывается с помощью `'.'` для разделения уровней, например, «Archived.2005.07».186187#### `colon`188189Спецификация Maildir требует использования двоеточия (`':'`) в некоторых именах файлов сообщений. Однако некоторые операционные системы не допускают этот символ в именах файлов. Если вы хотите использовать формат, подобный Maildir, в такой операционной системе, следует указать другой символ для замены. Восклицательный знак (`'!'`) – популярный выбор. Например:190191```python192import mailbox193mailbox.Maildir.colon = '!'194```195196Атрибут `colon` также может быть установлен для каждого экземпляра отдельно.197198Изменено в версии 3.13: `Maildir` теперь игнорирует файлы, начинающиеся с точки.199200Экземпляры `Maildir` имеют все методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), а также следующие:201202#### `list_folders()`203204Возвращает список имён всех папок.205206#### `get_folder(folder)`207208Возвращает экземпляр `Maildir`, представляющий папку с именем *folder*. Если папка не существует, возбуждается исключение [`NoSuchMailboxError`](https://python-all.ru/3/library/mailbox.html#mailbox.NoSuchMailboxError).209210#### `add_folder(folder)`211212Создаёт папку с именем *folder* и возвращает экземпляр `Maildir`, представляющий её.213214#### `remove_folder(folder)`215216Удаляет папку с именем *folder*. Если папка содержит какие-либо сообщения, будет возбуждено исключение [`NotEmptyError`](https://python-all.ru/3/library/mailbox.html#mailbox.NotEmptyError), и папка удалена не будет.217218#### `clean()`219220Удаляет временные файлы из почтового ящика, к которым не было обращений за последние 36 часов. Спецификация Maildir утверждает, что программы чтения почты должны делать это время от времени.221222#### `get_flags(key)`223224Возвращает в виде строки флаги, установленные для сообщения, соответствующего *key*. Это то же самое, что и `get_message(key).get_flags()`, но гораздо быстрее, поскольку не открывает файл сообщения. Используйте этот метод при переборе ключей, чтобы определить, какие сообщения стоит получить.225226Если у вас есть объект [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), используйте его метод [`get_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.get_flags), поскольку изменения, внесенные методами [`set_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.set_flags), [`add_flag()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.add_flag) и [`remove_flag()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.remove_flag) сообщения, не отражаются здесь до вызова метода [`__setitem__()`](https://python-all.ru/3/library/mailbox.html#mailbox.Maildir.__setitem__) почтового ящика.227228Добавлено в версии 3.13.229230#### `set_flags(key, flags)`231232Для сообщения, соответствующего *key*, установить флаги, указанные в *flags*, и сбросить все остальные. Вызов `some_mailbox.set_flags(key, flags)` аналогичен233234```python235one_message = some_mailbox.get_message(key)236one_message.set_flags(flags)237some_mailbox[key] = one_message238```239240но быстрее, поскольку не открывает файл сообщения.241242Если у вас есть объект [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), используйте его метод [`set_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.set_flags), поскольку изменения, внесенные этим методом почтового ящика, не будут видны методу объекта сообщения, [`get_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.get_flags).243244Добавлено в версии 3.13.245246#### `add_flag(key, flag)`247248Для сообщения, соответствующего *key*, установить флаги, указанные в *flag*, не изменяя другие флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа.249250Соображения по использованию этого метода по сравнению с методом [`add_flag()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.add_flag) объекта сообщения аналогичны таковым для [`set_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.Maildir.set_flags); см. обсуждение там.251252Добавлено в версии 3.13.253254#### `remove_flag(key, flag)`255256Для сообщения, соответствующего *key*, сбросить флаги, указанные в *flag*, не изменяя другие флаги. Чтобы удалить более одного флага за раз, *flag* может быть строкой из более чем одного символа.257258Соображения по использованию этого метода по сравнению с методом [`remove_flag()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.remove_flag) объекта сообщения аналогичны таковым для [`set_flags()`](https://python-all.ru/3/library/mailbox.html#mailbox.Maildir.set_flags); см. обсуждение там.259260Добавлено в версии 3.13.261262#### `get_info(key)`263264Возвращает строку, содержащую информацию для сообщения, соответствующего *key*. Это то же самое, что и `get_message(key).get_info()`, но гораздо быстрее, поскольку не открывает файл сообщения. Используйте этот метод при переборе ключей, чтобы определить, какие сообщения стоит получить.265266Если у вас есть объект [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), используйте его метод [`get_info()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.get_info), поскольку изменения, внесенные методом [`set_info()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.set_info) сообщения, не отражаются здесь до вызова метода [`__setitem__()`](https://python-all.ru/3/library/mailbox.html#mailbox.Maildir.__setitem__) почтового ящика.267268Добавлено в версии 3.13.269270#### `set_info(key, info)`271272Устанавливает информацию сообщения, соответствующего *key*, в *info*. Вызов `some_mailbox.set_info(key, flags)` аналогичен273274```python275one_message = some_mailbox.get_message(key)276one_message.set_info(info)277some_mailbox[key] = one_message278```279280но быстрее, поскольку не открывает файл сообщения.281282Если у вас есть объект [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), используйте его метод [`set_info()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.set_info), поскольку изменения, внесенные этим методом почтового ящика, не будут видны методу объекта сообщения, [`get_info()`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage.get_info).283284Добавлено в версии 3.13.285286Некоторые методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), реализованные в `Maildir`, заслуживают особых замечаний:287288#### `add(message)`289290#### `__setitem__(key, message)`291292#### `update(arg)`293294> **Предупреждение**295>296> Эти методы генерируют уникальные имена файлов на основе идентификатора текущего процесса. При использовании нескольких потоков возможны незамеченные конфликты имен, которые могут привести к повреждению почтового ящика, если потоки не скоординированы, чтобы избежать одновременного использования этих методов для управления одним и тем же почтовым ящиком.297298#### `flush()`299300Все изменения в почтовых ящиках Maildir применяются немедленно, поэтому этот метод ничего не делает.301302#### `lock()`303304#### `unlock()`305306Почтовые ящики Maildir не поддерживают (и не требуют) блокировку, поэтому эти методы ничего не делают.307308#### `close()`309310Экземпляры `Maildir` не держат открытых файлов, а нижележащие почтовые ящики не поддерживают блокировку, поэтому этот метод ничего не делает.311312#### `get_file(key)`313314В зависимости от платформы может быть невозможно изменить или удалить нижележащее сообщение, пока возвращенный файл остается открытым.315316> **См. также**317>318> **[man-страница maildir из Courier](https://python-all.ru/3/library/mailbox.html)**319>320> Спецификация формата. Описывает общее расширение для поддержки папок.321>322> **[Использование формата maildir](https://python-all.ru/3/library/mailbox.html)**323>324> Заметки о Maildir от его создателя. Включают обновлённую схему создания имён и детали семантики «info».325326### `mbox` объекты327328#### `class mailbox.mbox(path, factory=None, create=True)`329330Подкласс [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате mbox. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равен `None`, в качестве представления сообщения по умолчанию используется [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage). Если *create* равен `True`, почтовый ящик создаётся, если он не существует.331332Формат mbox – это классический формат хранения почты в системах Unix. Все сообщения в почтовом ящике mbox хранятся в одном файле, при этом начало каждого сообщения обозначается строкой, первые пять символов которой – «From ».333334Существует несколько вариаций формата mbox, призванных устранить недостатки оригинала. В целях совместимости `mbox` реализует оригинальный формат, который иногда называют *mboxo*. Это означает, что заголовок *Content-Length*, если он присутствует, игнорируется, а все вхождения «From » в начале строки в теле сообщения преобразуются в «\>From » при сохранении сообщения, хотя при чтении сообщения вхождения «\>From » обратно не преобразуются.335336Некоторые методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), реализованные в `mbox`, заслуживают особых замечаний:337338#### `get_bytes(key, from_=False)`339340Примечание: Этот метод имеет дополнительный параметр (*from\_*) по сравнению с другими классами. Первая строка записи файла mbox – это строка Unix «From ». Если *from\_* равен False, первая строка файла отбрасывается.341342#### `get_file(key, from_=False)`343344Использование файла после вызова [`flush()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.flush) или [`close()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.close) для экземпляра `mbox` может привести к непредсказуемым результатам или вызвать исключение.345346Примечание: Этот метод имеет дополнительный параметр (*from\_*) по сравнению с другими классами. Первая строка записи файла mbox – это строка Unix «From ». Если *from\_* равен False, первая строка файла отбрасывается.347348#### `get_string(key, from_=False)`349350Примечание: Этот метод имеет дополнительный параметр (*from\_*) по сравнению с другими классами. Первая строка записи файла mbox – это строка Unix «From ». Если *from\_* равен False, первая строка файла отбрасывается.351352#### `lock()`353354#### `unlock()`355356Используются три механизма блокировки – блокировка через dot-файл и, если доступны, системные вызовы `flock()` и `lockf()`.357358> **См. также**359>360> **[Страница man mbox из tin](https://python-all.ru/3/library/mailbox.html)**361>362> Спецификация формата с подробностями о блокировке.363>364> **[Настройка Netscape Mail в Unix: почему формат Content-Length плох](https://python-all.ru/3/library/mailbox.html)**365>366> Аргумент в пользу использования оригинального формата mbox, а не его вариации.367>368> **[«mbox» – это семейство нескольких взаимно несовместимых форматов почтовых ящиков](https://python-all.ru/3/library/mailbox.html)**369>370> История вариаций mbox.371372### `MH` объекты373374#### `class mailbox.MH(path, factory=None, create=True)`375376Подкласс [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате MH. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равен `None`, в качестве представления сообщения по умолчанию используется [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage). Если *create* равен `True`, почтовый ящик создаётся, если он не существует.377378MH – это формат почтовых ящиков на основе каталогов, разработанный для MH Message Handling System, почтового клиента. Каждое сообщение в почтовом ящике MH находится в собственном файле. Почтовый ящик MH может содержать другие почтовые ящики MH (называемые *папками*) помимо сообщений. Папки могут быть вложены неограниченно. Почтовые ящики MH также поддерживают *последовательности* – именованные списки, используемые для логической группировки сообщений без их перемещения в подпапки. Последовательности определяются в файле с именем `.mh_sequences` в каждой папке.379380Класс `MH` управляет почтовыми ящиками MH, но не пытается эмулировать все поведения **mh**. В частности, он не изменяет и не зависит от файлов `context` и `.mh_profile`, которые используются программой **mh** для хранения своего состояния и конфигурации.381382Экземпляры `MH` имеют все методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), а также следующие:383384Изменено в версии 3.13: Добавлена поддержка папок, не содержащих файла `.mh_sequences`.385386#### `list_folders()`387388Возвращает список имён всех папок.389390#### `get_folder(folder)`391392Возвращает экземпляр `MH`, представляющий папку с именем *folder*. Исключение [`NoSuchMailboxError`](https://python-all.ru/3/library/mailbox.html#mailbox.NoSuchMailboxError) возникает, если папка не существует.393394#### `add_folder(folder)`395396Создаёт папку с именем *folder* и возвращает экземпляр `MH` представляющий её.397398#### `remove_folder(folder)`399400Удаляет папку с именем *folder*. Если папка содержит сообщения, будет возбуждено исключение [`NotEmptyError`](https://python-all.ru/3/library/mailbox.html#mailbox.NotEmptyError), и папка не будет удалена.401402#### `get_sequences()`403404Возвращает словарь, где имена последовательностей сопоставлены со списками ключей. Если последовательностей нет, возвращается пустой словарь.405406#### `set_sequences(sequences)`407408Переопределяет последовательности, существующие в почтовом ящике, на основе *sequences*, словаря, где имена сопоставлены со списками ключей, аналогично возвращаемому [`get_sequences()`](https://python-all.ru/3/library/mailbox.html#mailbox.MH.get_sequences).409410#### `pack()`411412Переименовывает сообщения в почтовом ящике по мере необходимости для устранения пропусков в нумерации. Записи в списке последовательностей обновляются соответствующим образом.413414> **Примечание**415>416> Ранее выданные ключи становятся недействительными в результате этой операции и не должны использоваться в дальнейшем.417418Некоторые методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), реализованные в `MH`, заслуживают отдельных замечаний:419420#### `remove(key)`421422#### `__delitem__(key)`423424#### `discard(key)`425426Эти методы немедленно удаляют сообщение. Соглашение MH помечать сообщение на удаление добавлением запятой к его имени не используется.427428#### `lock()`429430#### `unlock()`431432Используются три механизма блокировки: точечная блокировка и, если доступны, системные вызовы `flock()` и `lockf()`. Для почтовых ящиков MH блокировка почтового ящика означает блокировку файла `.mh_sequences` и, только на время любых операций, затрагивающих их, блокировку отдельных файлов сообщений.433434#### `get_file(key)`435436В зависимости от платформы может быть невозможно удалить базовое сообщение, пока возвращённый файл остаётся открытым.437438#### `flush()`439440Все изменения в почтовых ящиках MH применяются немедленно, поэтому этот метод ничего не делает.441442#### `close()`443444Экземпляры `MH` не держат открытых файлов, поэтому этот метод эквивалентен [`unlock()`](https://python-all.ru/3/library/mailbox.html#mailbox.MH.unlock).445446> **См. также**447>448> **[nmh – система обработки сообщений](https://python-all.ru/3/library/mailbox.html)**449>450> Домашняя страница **nmh**, обновлённой версии исходного **mh**.451>452> **[MH и nmh: электронная почта для пользователей и программистов](https://python-all.ru/3/library/mailbox.html)**453>454> Книга, лицензированная под GPL, о **mh** и **nmh**, с некоторой информацией о формате почтового ящика.455456### `Babyl` объекты457458#### `class mailbox.Babyl(path, factory=None, create=True)`459460Подкласс [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате Babyl. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.461462Babyl – это однофайловый формат почтового ящика, используемый почтовым клиентом Rmail, входящим в состав Emacs. Начало сообщения обозначается строкой, содержащей два символа: Control-Подчёркивание (`'\037'`) и Control-L (`'\014'`). Конец сообщения обозначается началом следующего сообщения или, в случае последнего сообщения, строкой, содержащей символ Control-Подчёркивание (`'\037'`).463464Сообщения в почтовом ящике Babyl имеют два набора заголовков: исходные заголовки и так называемые видимые заголовки. Видимые заголовки обычно являются подмножеством исходных заголовков, которые были переформатированы или сокращены для большей привлекательности. Каждое сообщение в почтовом ящике Babyl также имеет сопутствующий список *меток* (коротких строк, которые записывают дополнительную информацию о сообщении), а список всех определённых пользователем меток, найденных в почтовом ящике, хранится в разделе параметров Babyl.465466Экземпляры `Babyl` имеют все методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), а также следующие:467468#### `get_labels()`469470Возвращает список имён всех определённых пользователем меток, используемых в почтовом ящике.471472> **Примечание**473>474> Фактические сообщения проверяются для определения того, какие метки существуют в почтовом ящике, вместо обращения к списку меток в разделе параметров Babyl, но раздел Babyl обновляется при каждом изменении почтового ящика.475476Некоторые методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), реализованные в `Babyl`, заслуживают особых замечаний:477478#### `get_file(key)`479480В почтовых ящиках Babyl заголовки сообщения не хранятся непрерывно с телом сообщения. Чтобы создать файлоподобное представление, заголовки и тело копируются вместе в экземпляр [`io.BytesIO`](https://python-all.ru/3/library/io.html#io.BytesIO), API которого идентичен API файла. В результате файлоподобный объект полностью независим от нижележащего почтового ящика, но не экономит память по сравнению со строковым представлением.481482#### `lock()`483484#### `unlock()`485486Используются три механизма блокировки: точечная блокировка (dot locking) и, если доступны, системные вызовы `flock()` и `lockf()`.487488> **См. также**489>490> **[Формат файлов Babyl версии 5](https://python-all.ru/3/library/mailbox.html)**491>492> Спецификация формата Babyl.493>494> **[Чтение почты с помощью Rmail](https://python-all.ru/3/library/mailbox.html)**495>496> Руководство по Rmail, содержащее некоторую информацию о семантике Babyl.497498### `MMDF` объекты499500#### `class mailbox.MMDF(path, factory=None, create=True)`501502Подкласс [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате MMDF. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя так, как если бы оно было открыто в двоичном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.503504MMDF – это однофайловый формат почтового ящика, разработанный для Multichannel Memorandum Distribution Facility, агента передачи почты. Каждое сообщение имеет ту же форму, что и сообщение mbox, но обрамляется строками, содержащими четыре символа Control-A (`'\001'`). Как и в формате mbox, начало каждого сообщения обозначается строкой, первые пять символов которой – «From », но дополнительные вхождения «From » не преобразуются в «\>From » при сохранении сообщений, поскольку дополнительные строки-разделители сообщений предотвращают ошибочный приём таких вхождений за начала последующих сообщений.505506Некоторые методы [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox), реализованные в `MMDF`, заслуживают особых замечаний:507508#### `get_bytes(key, from_=False)`509510Примечание: Этот метод имеет дополнительный параметр (*from\_*) по сравнению с другими классами. Первая строка записи в файле mbox – это строка Unix «From ». Если *from\_* равно False, первая строка файла опускается.511512#### `get_file(key, from_=False)`513514Использование файла после вызова [`flush()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.flush) или [`close()`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox.close) для экземпляра `MMDF` может привести к непредсказуемым результатам или возбудить исключение.515516Примечание: Этот метод имеет дополнительный параметр (*from\_*) по сравнению с другими классами. Первая строка записи в файле mbox – это строка Unix «From ». Если *from\_* равно False, первая строка файла опускается.517518#### `lock()`519520#### `unlock()`521522Используются три механизма блокировки: точечная блокировка (dot locking) и, если доступны, системные вызовы `flock()` и `lockf()`.523524> **См. также**525>526> **[страница руководства mmdf из tin](https://python-all.ru/3/library/mailbox.html)**527>528> Спецификация формата MMDF из документации tin, программы для чтения новостей.529>530> **[MMDF](https://python-all.ru/3/library/mailbox.html)**531>532> Статья в Википедии, описывающая Multichannel Memorandum Distribution Facility.533534## `Message` объекты535536#### `class mailbox.Message(message=None)`537538Подкласс [`email.message`](https://python-all.ru/3/library/email.message.html#module-email.message) модуля [`Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message). Подклассы `mailbox.Message` добавляют состояние и поведение, специфичные для формата почтового ящика.539540Если *message* опущен, новый экземпляр создаётся в состоянии по умолчанию, пустом. Если *message* является экземпляром [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message), его содержимое копируется; кроме того, любая формат-специфичная информация преобразуется по мере возможности, если *message* является экземпляром `Message`. Если *message* является строкой, строкой байтов или файлом, он должен содержать сообщение, соответствующее [**RFC 5322**](https://python-all.ru/3/library/mailbox.html), которое читается и разбирается. Файлы должны открываться в двоичном режиме, но файлы в текстовом режиме принимаются для обратной совместимости.541542Формат-специфичные состояния и поведение, предоставляемые подклассами, различаются, но в целом поддерживаются только те свойства, которые не привязаны к конкретному почтовому ящику (хотя, предположительно, эти свойства специфичны для конкретного формата почтового ящика). Например, смещения в файлах для однофайловых форматов почтовых ящиков и имена файлов для форматов на основе каталогов не сохраняются, так как они применимы только к исходному почтовому ящику. Но такие состояния, как было ли сообщение прочитано пользователем или помечено как важное, сохраняются, поскольку они относятся к самому сообщению.543544Нет требования, чтобы экземпляры `Message` использовались для представления сообщений, полученных с помощью экземпляров [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox). В некоторых ситуациях время и память, необходимые для создания представлений `Message`, могут оказаться неприемлемыми. Для таких случаев экземпляры `Mailbox` также предлагают строковые и файлоподобные представления, а пользовательская фабрика сообщений может быть указана при инициализации экземпляра `Mailbox`.545546### `MaildirMessage` объекты547548#### `class mailbox.MaildirMessage(message=None)`549550Сообщение с поведением, специфичным для Maildir. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message).551552Обычно почтовый клиент перемещает все сообщения из подкаталога `new` в подкаталог `cur` после того, как пользователь впервые открывает и закрывает почтовый ящик, отмечая, что сообщения старые, независимо от того, были ли они фактически прочитаны. Каждое сообщение в `cur` имеет раздел «info», добавленный к его имени файла для хранения информации о его состоянии. (Некоторые почтовые программы могут также добавлять раздел «info» к сообщениям в `new`.) Раздел «info» может принимать одну из двух форм: он может содержать «2,» с последующим списком стандартизированных флагов (например, «2,FR») или может содержать «1,» с последующей так называемой экспериментальной информацией. Стандартные флаги для сообщений Maildir следующие:553554| Флаг | Значение | Пояснение |555| --- | --- | --- |556| D | Черновик | В процессе составления |557| F | Отмечен | Помечен как важный |558| P | Передан | Переслано, отправлено повторно или возвращено |559| R | Отвечено | Дан ответ |560| S | Просмотрено | Прочитано |561| T | Удалено | Отмечено для последующего удаления |562563Экземпляры `MaildirMessage` предоставляют следующие методы:564565#### `get_subdir()`566567Возвращает «new» (если сообщение должно храниться в подкаталоге `new` или «cur» (если сообщение должно храниться в подкаталоге `cur`).568569> **Примечание**570>571> Сообщение обычно перемещается из `new` в `cur` после того, как к почтовому ящику был произведён доступ, независимо от того, было ли сообщение прочитано. Сообщение `msg` было прочитано, если `"S" in msg.get_flags()` равно `True`.572573#### `set_subdir(subdir)`574575Устанавливает подкаталог, в котором должно храниться сообщение. Параметр *subdir* должен быть либо «new», либо «cur».576577#### `get_flags()`578579Возвращает строку, указывающую текущие установленные флаги. Если сообщение соответствует стандартному формату Maildir, результатом является конкатенация в алфавитном порядке нуля или одного вхождения каждого из `'D'`, `'F'`, `'P'`, `'R'`, `'S'` и `'T'`. Возвращается пустая строка, если флаги не установлены или если «info» содержит экспериментальную семантику.580581#### `set_flags(flags)`582583Устанавливает флаги, указанные *flags*, и сбрасывает все остальные.584585#### `add_flag(flag)`586587Устанавливает флаг(и), указанные *flag*, не изменяя остальные флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа. Текущий «info» перезаписывается, независимо от того, содержит ли он экспериментальную информацию вместо флагов.588589#### `remove_flag(flag)`590591Сбрасывает флаг(и), указанные в *flag*, не изменяя остальные флаги. Чтобы сбросить несколько флагов одновременно, *flag* может быть строкой из нескольких символов. Если «info» содержит экспериментальную информацию, а не флаги, текущее «info» не изменяется.592593#### `get_date()`594595Возвращает дату доставки сообщения в виде числа с плавающей запятой, представляющего количество секунд с начала эпохи.596597#### `set_date(date)`598599Устанавливает дату доставки сообщения в *date*, число с плавающей запятой, представляющее количество секунд с начала эпохи.600601#### `get_info()`602603Возвращает строку, содержащую «info» для сообщения. Это полезно для доступа к экспериментальному «info» и его изменения (т.е. не являющегося списком флагов).604605#### `set_info(info)`606607Устанавливает «info» в *info*, которое должно быть строкой.608609Когда экземпляр `MaildirMessage` создаётся на основе экземпляра [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и выполняются следующие преобразования:610611| Результирующее состояние | [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage) состояние |612| --- | --- |613| Подкаталог «cur» | Флаг O |614| Флаг F | Флаг F |615| Флаг R | Флаг A |616| Флаг S | Флаг R |617| Флаг T | Флаг D |618619Когда экземпляр `MaildirMessage` создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage), выполняются следующие преобразования:620621| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage) |622| --- | --- |623| Подкаталог «cur» | Последовательность «unseen» |624| Подкаталог «cur» и флаг S | Нет последовательности «unseen» |625| Флаг F | Последовательность «flagged» |626| Флаг R | последовательность «replied» |627628Когда экземпляр `MaildirMessage` создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage), выполняются следующие преобразования:629630| Результирующее состояние | состояние [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage) |631| --- | --- |632| подкаталог «cur» | метка «unseen» |633| подкаталог «cur» и флаг S | без метки «unseen» |634| Флаг P | метка «forwarded» или «resent» |635| Флаг R | метка «answered» |636| Флаг T | метка «deleted» |637638### `mboxMessage` объекты639640#### `class mailbox.mboxMessage(message=None)`641642Сообщение с поведением, специфичным для mbox. Параметр *message* имеет тот же смысл, что и в конструкторе [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message).643644Сообщения в почтовом ящике mbox хранятся вместе в одном файле. Адрес отправителя в конверте и время доставки обычно хранятся в строке, начинающейся с «From », которая используется для обозначения начала сообщения, хотя точный формат этих данных сильно различается в разных реализациях mbox. Флаги, указывающие состояние сообщения, например, было ли оно прочитано или помечено как важное, обычно хранятся в заголовках *Status* и *X-Status*.645646Обычные флаги для сообщений mbox:647648| Флаг | Значение | Пояснение |649| --- | --- | --- |650| R | Прочитано | Прочитано |651| O | Старое | Ранее обнаружено почтовым клиентом |652| D | Удалено | Помечено для последующего удаления |653| F | Помечено | Помечено как важное |654| A | Отвечено | Дан ответ |655656Флаги «R» и «O» хранятся в заголовке *Status*, а флаги «D», «F» и «A» – в заголовке *X-Status*. Обычно флаги и заголовки располагаются в указанном порядке.657658Экземпляры `mboxMessage` предоставляют следующие методы:659660#### `get_from()`661662Возвращает строку, представляющую строку “From “, которая отмечает начало сообщения в почтовом ящике mbox. Начальная строка “From “ и завершающий символ новой строки не включаются.663664#### `set_from(from_, time_=None)`665666Устанавливает строку “From “ в значение *from\_*, которое должно быть указано без начальной строки “From “ или завершающего символа новой строки. Для удобства можно указать *time\_*; он будет соответствующим образом отформатирован и добавлен к *from\_*. Если *time\_* указан, это должен быть экземпляр [`time.struct_time`](https://python-all.ru/3/library/time.html#time.struct_time), кортеж, подходящий для передачи в [`time.strftime()`](https://python-all.ru/3/library/time.html#time.strftime), или `True` (чтобы использовать [`time.gmtime()`](https://python-all.ru/3/library/time.html#time.gmtime)).667668#### `get_flags()`669670Возвращает строку, указывающую установленные в данный момент флаги. Если сообщение соответствует обычному формату, результатом является конкатенация в следующем порядке нуля или одного вхождения каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.671672#### `set_flags(flags)`673674Устанавливает флаги, указанные в *flags*, и сбрасывает все остальные. Параметр *flags* должен быть конкатенацией в произвольном порядке нуля или более вхождений каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.675676#### `add_flag(flag)`677678Устанавливает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа.679680#### `remove_flag(flag)`681682Сбрасывает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы удалить более одного флага за раз, *flag* может быть строкой из более чем одного символа.683684Когда экземпляр `mboxMessage` создается на основе экземпляра [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), строка “From “ генерируется на основе даты доставки экземпляра `MaildirMessage`, и происходят следующие преобразования:685686| Результирующее состояние | [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage) состояние |687| --- | --- |688| Флаг R | Флаг S |689| Флаг O | подкаталог “cur” |690| Флаг D | Флаг T |691| Флаг F | Флаг F |692| Флаг A | Флаг R |693694Когда экземпляр `mboxMessage` создается на основе экземпляра [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:695696| Результирующее состояние | [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage) состояние |697| --- | --- |698| Флаг R и флаг O | нет последовательности “unseen” |699| Флаг O | последовательность “unseen” |700| Флаг F | «помеченная» последовательность |701| Флаг | «отвеченная» последовательность |702703Когда экземпляр `mboxMessage` создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:704705| Результирующее состояние | состояние [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage) |706| --- | --- |707| Флаги R и O | нет метки «unseen» |708| флаг O | метка «unseen» |709| флаг D | метка «deleted» |710| флаг A | метка «answered» |711712Когда экземпляр `mboxMessage` создаётся на основе экземпляра [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage), строка «From » копируется, и все флаги напрямую соответствуют:713714| Результирующее состояние | состояние [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage) |715| --- | --- |716| флаг R | флаг R |717| флаг O | флаг O |718| флаг D | флаг D |719| флаг F | флаг F |720| флаг A | флаг A |721722### `MHMessage` объекты723724#### `class mailbox.MHMessage(message=None)`725726Сообщение с поведением, характерным для MH. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message).727728Сообщения MH не поддерживают метки и флаги в традиционном понимании, но поддерживают последовательности – логические группировки произвольных сообщений. Некоторые почтовые программы (хотя не стандартные **mh** и **nmh**) используют последовательности примерно так же, как флаги используются в других форматах:729730| Последовательность | Пояснение |731| --- | --- |732| unseen | Не прочитано, но ранее обнаружено MUA |733| отвечено | Отвечено |734| помечено | Помечено как важное |735736Экземпляры `MHMessage` предоставляют следующие методы:737738#### `get_sequences()`739740Возвращает список имен последовательностей, которые включают это сообщение.741742#### `set_sequences(sequences)`743744Устанавливает список последовательностей, которые включают это сообщение.745746#### `add_sequence(sequence)`747748Добавляет *sequence* в список последовательностей, которые включают это сообщение.749750#### `remove_sequence(sequence)`751752Удаляет *sequence* из списка последовательностей, которые включают это сообщение.753754Когда экземпляр `MHMessage` создается на основе экземпляра [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), происходят следующие преобразования:755756| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage) |757| --- | --- |758| последовательность «unseen» | нет флага S |759| последовательность «replied» | флаг R |760| последовательность «flagged» | флаг F |761762Когда экземпляр `MHMessage` создается на основе экземпляра [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и происходят следующие преобразования:763764| Результирующее состояние | Состояние [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage) |765| --- | --- |766| последовательность «unseen» | нет флага R |767| последовательность «replied» | флаг A |768| последовательность «flagged» | флаг F |769770Когда экземпляр `MHMessage` создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage), выполняются следующие преобразования:771772| Результирующее состояние | [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage) состояние |773| --- | --- |774| "unseen" последовательность | "unseen" метка |775| "replied" последовательность | "answered" метка |776777### `BabylMessage` объекты778779#### `class mailbox.BabylMessage(message=None)`780781Сообщение с поведением, специфичным для Babyl. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message).782783Некоторые метки сообщений, называемые *attributes*, по соглашению имеют специальное значение. Атрибуты следующие:784785| Метка | Пояснение |786| --- | --- |787| unseen | Не прочитано, но ранее обнаружено почтовым клиентом (MUA) |788| deleted | Помечено для последующего удаления |789| filed | Скопировано в другой файл или почтовый ящик |790| answered | Отвечено |791| forwarded | Переслано |792| edited | Изменено пользователем |793| resent | Отправлено повторно |794795По умолчанию Rmail отображает только видимые заголовки. Однако класс `BabylMessage` использует исходные заголовки, поскольку они более полны. При желании к видимым заголовкам можно обратиться явно.796797Экземпляры `BabylMessage` предоставляют следующие методы:798799#### `get_labels()`800801Возвращает список меток сообщения.802803#### `set_labels(labels)`804805Устанавливает список меток сообщения равным *labels*.806807#### `add_label(label)`808809Добавляет метку *label* в список меток сообщения.810811#### `remove_label(label)`812813Удаляет метку *label* из списка меток сообщения.814815#### `get_visible()`816817Возвращает экземпляр [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), заголовки которого – это видимые заголовки сообщения, а тело пусто.818819#### `set_visible(visible)`820821Устанавливает видимые заголовки сообщения такими же, как заголовки из *message*. Параметр *visible* должен быть экземпляром [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3/library/email.compat32-message.html#email.message.Message), строкой или файлоподобным объектом (который должен быть открыт в текстовом режиме).822823#### `update_visible()`824825Когда исходные заголовки экземпляра `BabylMessage` изменяются, видимые заголовки автоматически не изменяются для соответствия. Этот метод обновляет видимые заголовки следующим образом: каждый видимый заголовок с соответствующим исходным заголовком устанавливается в значение исходного заголовка, каждый видимый заголовок без соответствующего исходного заголовка удаляется, а любые из *Date*, *From*, *Reply-To*, *To*, *CC* и *Subject*, которые присутствуют в исходных заголовках, но отсутствуют в видимых заголовках, добавляются к видимым заголовкам.826827Когда экземпляр `BabylMessage` создаётся на основе экземпляра [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), происходят следующие преобразования:828829| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage) |830| --- | --- |831| Метка «unseen» | нет флага S |832| Метка «deleted» | Флаг T |833| Метка «answered» | Флаг R |834| Метка «forwarded» | Флаг P |835836Когда экземпляр `BabylMessage` создаётся на основе экземпляра [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и происходят следующие преобразования:837838| Результирующее состояние | [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MMDFMessage) состояние |839| --- | --- |840| Метка «unseen» | нет флага R |841| Метка «deleted» | Флаг D |842| Метка «answered» | Флаг A |843844Когда экземпляр `BabylMessage` создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:845846| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage) |847| --- | --- |848| «непрочитанная» метка | «непрочитанная» последовательность |849| «отвеченная» метка | «с ответом» последовательность |850851### `MMDFMessage` объекты852853#### `class mailbox.MMDFMessage(message=None)`854855Сообщение с поведением, специфичным для MMDF. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3/library/mailbox.html#mailbox.Message).856857Как и сообщения в почтовом ящике mbox, сообщения MMDF хранятся с адресом отправителя и датой доставки в начальной строке, начинающейся с «From ». Аналогично, флаги, указывающие на состояние сообщения, обычно хранятся в заголовках *Status* и *X-Status*.858859Стандартные флаги для сообщений MMDF совпадают с флагами сообщений mbox и перечислены ниже:860861| Флаг | Значение | Пояснение |862| --- | --- | --- |863| R | Прочитано | Прочитано |864| O | Старое | Ранее обнаружено почтовым клиентом |865| D | Удалено | Помечено для последующего удаления |866| F | Помечено | Помечено как важное |867| A | Отвечено | Получен ответ |868869Флаги «R» и «O» хранятся в заголовке *Status*, а флаги «D», «F» и «A» – в заголовке *X-Status*. Флаги и заголовки обычно располагаются в указанном порядке.870871Экземпляры `MMDFMessage` предоставляют следующие методы, идентичные методам, предоставляемым [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage):872873#### `get_from()`874875Возвращает строку, представляющую строку «From », которая отмечает начало сообщения в почтовом ящике mbox. Начальное «From » и завершающий символ новой строки не включаются.876877#### `set_from(from_, time_=None)`878879Устанавливает строку «From » равной *from\_*, которая должна быть указана без начального «From » и завершающего символа новой строки. Для удобства можно указать *time\_*; она будет соответствующим образом отформатирована и добавлена к *from\_*. Если *time\_* указан, он должен быть экземпляром [`time.struct_time`](https://python-all.ru/3/library/time.html#time.struct_time), кортежем, подходящим для передачи в [`time.strftime()`](https://python-all.ru/3/library/time.html#time.strftime), или `True` (чтобы использовать [`time.gmtime()`](https://python-all.ru/3/library/time.html#time.gmtime)).880881#### `get_flags()`882883Возвращает строку, указывающую установленные флаги. Если сообщение соответствует стандартному формату, результатом является конкатенация в следующем порядке нуля или одного вхождения каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.884885#### `set_flags(flags)`886887Устанавливает флаги, указанные в *flags*, и снимает все остальные. Параметр *flags* должен быть конкатенацией в произвольном порядке нуля или более вхождений каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.888889#### `add_flag(flag)`890891Устанавливает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа.892893#### `remove_flag(flag)`894895Снимает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы удалить более одного флага за раз, *flag* может быть строкой из более чем одного символа.896897Когда экземпляр `MMDFMessage` создаётся на основе экземпляра [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage), строка «From» генерируется на основе даты доставки экземпляра `MaildirMessage`, и происходят следующие преобразования:898899| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MaildirMessage) |900| --- | --- |901| Флаг R | Флаг S |902| Флаг O | Подкаталог «cur» |903| Флаг D | Флаг T |904| Флаг F | Флаг F |905| Флаг A | Флаг R |906907Когда экземпляр `MMDFMessage` создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:908909| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.MHMessage) |910| --- | --- |911| Флаг R и флаг O | нет последовательности «unseen» |912| Флаг O | последовательность «unseen» |913| Флаг F | последовательность «flagged» |914| Флаг A | последовательность «replied» |915916Когда экземпляр `MMDFMessage` создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:917918| Результирующее состояние | Состояние [`BabylMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.BabylMessage) |919| --- | --- |920| Флаг R и флаг O | нет метки «unseen» |921| Флаг O | метка «unseen» |922| Флаг D | метка «удалено» |923| Флаг | метка «отвечено» |924925Когда экземпляр `MMDFMessage` создаётся на основе экземпляра [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage), строка «From» копируется, и все флаги напрямую соответствуют:926927| Результирующее состояние | Состояние [`mboxMessage`](https://python-all.ru/3/library/mailbox.html#mailbox.mboxMessage) |928| --- | --- |929| Флаг R | Флаг R |930| Флаг O | Флаг O |931| Флаг D | Флаг D |932| Флаг F | Флаг F |933| Флаг A | Флаг A |934935## Исключения936937В модуле `mailbox` определены следующие классы исключений:938939#### `exception mailbox.Error`940941Базовый класс для всех остальных исключений модуля.942943#### `exception mailbox.NoSuchMailboxError`944945Вызывается, когда ожидается почтовый ящик, но он не найден, например, при создании экземпляра подкласса [`Mailbox`](https://python-all.ru/3/library/mailbox.html#mailbox.Mailbox) с несуществующим путём (и с параметром *create*, установленным в `False`) или при открытии несуществующей папки.946947#### `exception mailbox.NotEmptyError`948949Вызывается, когда почтовый ящик не пуст, но ожидается пустым, например, при удалении папки, содержащей сообщения.950951#### `exception mailbox.ExternalClashError`952953Вызывается, когда некое условие, связанное с почтовым ящиком и не зависящее от программы, не позволяет ей продолжить работу, например, при неудачной попытке получить блокировку, которую уже удерживает другая программа, или когда уникальное имя файла уже существует.954955#### `exception mailbox.FormatError`956957Вызывается, когда данные в файле не могут быть разобраны, например, когда экземпляр [`MH`](https://python-all.ru/3/library/mailbox.html#mailbox.MH) пытается прочитать повреждённый файл `.mh_sequences`.958959## Примеры960961Простой пример вывода тем всех сообщений в почтовом ящике, которые кажутся интересными:962963```python964import mailbox965for message in mailbox.mbox('~/mbox'):966    subject = message['subject']       # Может быть None.967    if subject and 'python' in subject.lower():968        print(subject)969```970971Чтобы скопировать все письма из почтового ящика Babyl в почтовый ящик MH, преобразуя всю форматно-специфичную информацию, которую можно преобразовать:972973```python974import mailbox975destination = mailbox.MH('~/Mail')976destination.lock()977for message in mailbox.Babyl('~/RMAIL'):978    destination.add(mailbox.MHMessage(message))979destination.flush()980destination.unlock()981```982983Этот пример сортирует письма из нескольких списков рассылки по разным почтовым ящикам, стараясь избежать повреждения писем из-за одновременного изменения другими программами, потери писем из-за прерывания программы или преждевременного завершения из-за повреждённых сообщений в почтовом ящике:984985```python986import mailbox987import email.errors988989list_names = ('python-list', 'python-dev', 'python-bugs')990991boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names}992inbox = mailbox.Maildir('~/Maildir', factory=None)993994for key in inbox.iterkeys():995    try:996        message = inbox[key]997    except email.errors.MessageParseError:998        continue                # Сообщение повреждено. Просто оставьте его.9991000    for name in list_names:1001        list_id = message['list-id']1002        if list_id and name in list_id:1003            # Получить почтовый ящик для использования.1004            box = boxes[name]10051006            # Записать копию на диск перед удалением оригинала.1007            # Если произошёл сбой, возможно дублирование сообщения, но1008            # это лучше, чем полная потеря сообщения.1009            box.lock()1010            box.add(message)1011            box.flush()1012            box.unlock()10131014            # Удалить исходное сообщение1015            inbox.lock()1016            inbox.discard(key)1017            inbox.flush()1018            inbox.unlock()1019            break               # Целевой получатель найден, поиск прекращён.10201021for box in boxes.itervalues():1022    box.close()1023```1024