`mailbox.md`

940 строк · 94.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/mailbox.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 19.4. [`mailbox`](https://python-all.ru/3.6/library/mailbox.html#module-mailbox) – Управление почтовыми ящиками в различных форматах89**Исходный код:** [Lib/mailbox.py](https://python-all.ru/src/3.6/Lib/mailbox.py)1011---1213Этот модуль определяет два класса: [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) и [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) для доступа к почтовым ящикам на диске и управления ими, а также для работы с содержащимися в них сообщениями. [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) предоставляет словареподобное отображение ключей на сообщения. [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) расширяет класс [`Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message) из модуля [`email.message`](https://python-all.ru/3.6/library/email.message.html#module-email.message), добавляя формат-специфичное состояние и поведение. Поддерживаемые форматы почтовых ящиков: Maildir, mbox, MH, Babyl и MMDF.1415> **См. также**16>17> **Модуль [`email`](https://python-all.ru/3.6/library/email.html#module-email)**18>19> Представление сообщений и управление ими.2021## 19.4.1. [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) объекты2223#### `class mailbox.Mailbox`2425Почтовый ящик, который можно просматривать и изменять.2627Класс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) определяет интерфейс и не предназначен для создания экземпляров. Вместо этого следует наследовать формат-специфичные подклассы от [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), а код должен создавать экземпляры конкретного подкласса.2829Интерфейс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) напоминает словарь: небольшие ключи соответствуют сообщениям. Ключи выдаются экземпляром [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), с которым они будут использоваться, и имеют смысл только для этого экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox). Ключ продолжает идентифицировать сообщение, даже если соответствующее сообщение изменяется, например, заменяется другим сообщением.3031Сообщения можно добавлять в экземпляр [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) с помощью метода [`add()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.add) (подобного set) и удалять с помощью инструкции `del` или методов [`remove()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.remove) и [`discard()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.discard) (также подобных set).3233Семантика интерфейса [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) отличается от семантики словаря в некоторых важных аспектах. При каждом запросе сообщения на основе текущего состояния почтового ящика создаётся новое представление (обычно экземпляр [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message)). Аналогично, при добавлении сообщения в экземпляр [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) содержимое переданного представления сообщения копируется. Ни в одном из случаев экземпляр [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не сохраняет ссылку на представление сообщения.3435Итератор по умолчанию [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) перебирает представления сообщений, а не ключи, как это делает итератор словаря по умолчанию. Кроме того, изменение почтового ящика во время итерации безопасно и хорошо определено. Сообщения, добавленные в почтовый ящик после создания итератора, не будут видны итератору. Сообщения, удалённые из почтового ящика до того, как итератор их вернёт, будут молча пропущены, хотя использование ключа из итератора может привести к исключению [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если соответствующее сообщение будет впоследствии удалено.3637> **Предупреждение**38>39> Будьте предельно осторожны при изменении почтовых ящиков, которые могут одновременно изменяться другим процессом. Самый безопасный формат почтового ящика для таких задач – Maildir; старайтесь избегать использования однофайловых форматов, таких как mbox, для одновременной записи. Если вы изменяете почтовый ящик, вы *должны* заблокировать его, вызвав методы [`lock()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.lock) и [`unlock()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.unlock) *перед* чтением любых сообщений в файле или внесением каких-либо изменений путём добавления или удаления сообщения. Несоблюдение блокировки почтового ящика чревато потерей сообщений или повреждением всего почтового ящика.4041Экземпляры [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) имеют следующие методы:4243#### `add(message)`4445Добавляет *сообщение* в почтовый ящик и возвращает ключ, который был ему присвоен.4647Параметр *message* может быть экземпляром [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message), строкой, байтовой строкой или файлоподобным объектом (который должен быть открыт в двоичном режиме). Если *message* является экземпляром соответствующего формат-специфичного подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) (например, если это экземпляр [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage), а это экземпляр [`mbox`](https://python-all.ru/3.6/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.6/library/exceptions.html#KeyError), если метод был вызван как [`remove()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.remove) или [`__delitem__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__delitem__), но исключение не возникает, если метод был вызван как [`discard()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.discard). Поведение [`discard()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.discard) может быть предпочтительнее, если базовый формат почтового ящика поддерживает одновременное изменение другими процессами.6061#### `__setitem__(key, message)`6263Заменяет сообщение, соответствующее *ключу*, на *сообщение*. Возникает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если *ключу* ещё не соответствует ни одно сообщение.6465Как и в случае с [`add()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.add), параметр *message* может быть экземпляром [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message), строкой, байтовой строкой или файлоподобным объектом (который должен быть открыт в двоичном режиме). Если *message* является экземпляром соответствующего формат-специфичного подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) (например, если это экземпляр [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage), а это экземпляр [`mbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mbox)), используется его формат-специфичная информация. В противном случае формат-специфичная информация сообщения, которое в данный момент соответствует *ключу*, остаётся неизменной.6667#### `iterkeys()`6869#### `keys()`7071Возвращает итератор по всем ключам, если вызван как [`iterkeys()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.iterkeys), или возвращает список ключей, если вызван как [`keys()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.keys).7273#### `itervalues()`7475#### `__iter__()`7677#### `values()`7879Возвращает итератор по представлениям всех сообщений, если вызван как [`itervalues()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.itervalues) или [`__iter__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__iter__), или возвращает список таких представлений, если вызван как [`values()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.values). Сообщения представлены в виде экземпляров соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), зависящего от формата, если только при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не была указана пользовательская фабрика сообщений.8081> **Примечание**82>83> Поведение [`__iter__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__iter__) отличается от поведения словарей, которые перебирают ключи.8485#### `iteritems()`8687#### `items()`8889Возвращает итератор по парам (*key*, *message*), где *key* – ключ, а *message* – представление сообщения, если вызван как [`iteritems()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.iteritems), или возвращает список таких пар, если вызван как [`items()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.items). Сообщения представлены в виде экземпляров соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), зависящего от формата, если только при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не была указана пользовательская фабрика сообщений.9091#### `get(key, default=None)`9293#### `__getitem__(key)`9495Возвращает представление сообщения, соответствующего *ключу*. Если такого сообщения нет, *default* возвращается, если метод был вызван как [`get()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.get), и вызывается исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если метод был вызван как [`__getitem__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__getitem__). Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не была указана пользовательская фабрика сообщений.9697#### `get_message(key)`9899Возвращает представление сообщения, соответствующего *ключу*, в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), или вызывает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если такого сообщения нет.100101#### `get_bytes(key)`102103Возвращает байтовое представление сообщения, соответствующего *ключу*, или вызывает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если такого сообщения нет.104105Новое в версии 3.2.106107#### `get_string(key)`108109Возвращает строковое представление сообщения, соответствующего *ключу*, или вызывает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если такого сообщения нет. Сообщение обрабатывается через [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message) для преобразования в 7-битное чистое представление.110111#### `get_file(key)`112113Возвращает файлоподобное представление сообщения, соответствующего ключу *key*, или вызывает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), если такого сообщения не существует. Файлоподобный объект ведёт себя так, как если бы он был открыт в двоичном режиме. Этот файл следует закрыть, когда он больше не нужен.114115Изменено в версии 3.2: Файловый объект на самом деле является двоичным файлом; ранее он некорректно возвращался в текстовом режиме. Кроме того, файлоподобный объект теперь поддерживает протокол управления контекстом: для автоматического закрытия можно использовать оператор [`with`](https://python-all.ru/3.6/reference/compound_stmts.html#with).116117> **Примечание**118>119> В отличие от других представлений сообщений, файлоподобные представления не обязательно независимы от экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), который их создал, или от базового почтового ящика. Более подробная документация предоставляется каждым подклассом.120121#### `__contains__(key)`122123Возвращает `True`, если *ключ* соответствует сообщению, и `False` в противном случае.124125#### `__len__()`126127Возвращает количество сообщений в почтовом ящике.128129#### `clear()`130131Удаляет все сообщения из почтового ящика.132133#### `pop(key, default=None)`134135Возвращает представление сообщения, соответствующего *ключу*, и удаляет сообщение. Если такого сообщения нет, возвращает *default*. Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не была указана пользовательская фабрика сообщений.136137#### `popitem()`138139Возвращает произвольную пару (*ключ*, *сообщение*), где *ключ* – это ключ, а *сообщение* – представление сообщения, и удаляет соответствующее сообщение. Если почтовый ящик пуст, вызывает исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError). Сообщение представляется в виде экземпляра соответствующего подкласса [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), если только при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) не была указана пользовательская фабрика сообщений.140141#### `update(arg)`142143Параметр *arg* должен быть отображением *ключ* → *сообщение* или итерируемым объектом из пар (*ключ*, *сообщение*). Обновляет почтовый ящик так, что для каждой заданной пары *ключ* и *сообщение* сообщение, соответствующее *ключу*, устанавливается в *сообщение* как если бы с помощью [`__setitem__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__setitem__). Как и в случае с [`__setitem__()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.__setitem__), каждый *ключ* уже должен соответствовать сообщению в почтовом ящике, иначе будет вызвано исключение [`KeyError`](https://python-all.ru/3.6/library/exceptions.html#KeyError), поэтому в общем случае неправильно, чтобы *arg* был экземпляром [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox).144145> **Примечание**146>147> В отличие от словарей, именованные аргументы не поддерживаются.148149#### `flush()`150151Записывает все ожидающие изменения в файловую систему. Для некоторых подклассов [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) изменения всегда записываются сразу, и [`flush()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox.flush) ничего не делает, но всё же стоит выработать привычку вызывать этот метод.152153#### `lock()`154155Устанавливает исключительную рекомендательную блокировку на почтовый ящик, чтобы другие процессы знали, что его не следует изменять. Если блокировка недоступна, возбуждается исключение [`ExternalClashError`](https://python-all.ru/3.6/library/mailbox.html#mailbox.ExternalClashError). Конкретные механизмы блокировки зависят от формата почтового ящика. Перед любыми изменениями содержимого следует *всегда* блокировать почтовый ящик.156157#### `unlock()`158159Освобождает блокировку почтового ящика, если она установлена.160161#### `close()`162163Сбрасывает почтовый ящик, при необходимости снимает блокировку и закрывает все открытые файлы. Для некоторых подклассов [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) этот метод ничего не делает.164165### 19.4.1.1. [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir)166167#### `class mailbox.Maildir(dirname, factory=None, create=True)`168169Подкласс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате Maildir. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.170171По историческим причинам *dirname* назван так, а не *path*.172173Maildir – это почтовый формат на основе каталогов, разработанный для агента передачи почты qmail и ныне широко поддерживаемый другими программами. Сообщения в почтовом ящике Maildir хранятся в отдельных файлах в общей структуре каталогов. Такая архитектура позволяет нескольким независимым программам получать доступ и изменять почтовые ящики Maildir без повреждения данных, поэтому файловая блокировка не требуется.174175Почтовые ящики Maildir содержат три подкаталога: `tmp`, `new` и `cur`. Сообщения создаются в подкаталоге `tmp`, а затем перемещаются в подкаталог `new` для завершения доставки. После этого почтовый клиент может переместить сообщение в подкаталог `cur` и сохранить информацию о состоянии сообщения в специальном разделе «info», добавляемом к его имени файла.176177Также поддерживаются папки в стиле, введённом агентом передачи почты Courier. Любой подкаталог основного почтового ящика считается папкой, если первым символом в его имени является `'.'`. Имена папок представляются как [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir) без ведущего `'.'`. Каждая папка сама является почтовым ящиком Maildir, но не должна содержать другие папки. Вместо этого логическая вложенность указывается с помощью `'.'` для разделения уровней, например, «Archived.2005.07».178179> **Примечание**180>181> Спецификация Maildir требует использования двоеточия (`':'`) в некоторых именах файлов сообщений. Однако некоторые операционные системы не допускают этот символ в именах файлов. Если вы хотите использовать формат, подобный Maildir, в такой операционной системе, следует указать другой символ для замены. Восклицательный знак (`'!'`) – популярный выбор. Например:182>183> ```python184> import mailbox185> mailbox.Maildir.colon = '!'186> ```187>188> Атрибут `colon` также может быть установлен для каждого экземпляра отдельно.189190Экземпляры [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir) имеют все методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), а также следующие:191192#### `list_folders()`193194Возвращает список имён всех папок.195196#### `get_folder(folder)`197198Возвращает экземпляр [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir), представляющий папку с именем *folder*. Если папка не существует, возбуждается исключение [`NoSuchMailboxError`](https://python-all.ru/3.6/library/mailbox.html#mailbox.NoSuchMailboxError).199200#### `add_folder(folder)`201202Создаёт папку с именем *folder* и возвращает экземпляр [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir), представляющий её.203204#### `remove_folder(folder)`205206Удаляет папку с именем *folder*. Если папка содержит сообщения, будет возбуждено исключение [`NotEmptyError`](https://python-all.ru/3.6/library/mailbox.html#mailbox.NotEmptyError), и папка не будет удалена.207208#### `clean()`209210Удаляет временные файлы из почтового ящика, к которым не было обращений за последние 36 часов. Спецификация Maildir утверждает, что программы чтения почты должны делать это время от времени.211212Некоторые методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), реализованные в [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir), заслуживают особых замечаний:213214#### `add(message)`215216#### `__setitem__(key, message)`217218#### `update(arg)`219220> **Предупреждение**221>222> Эти методы генерируют уникальные имена файлов на основе идентификатора текущего процесса. При использовании нескольких потоков возможны незамеченные конфликты имен, которые могут привести к повреждению почтового ящика, если потоки не скоординированы, чтобы избежать одновременного использования этих методов для управления одним и тем же почтовым ящиком.223224#### `flush()`225226Все изменения в почтовых ящиках Maildir применяются немедленно, поэтому этот метод ничего не делает.227228#### `lock()`229230#### `unlock()`231232Почтовые ящики Maildir не поддерживают (и не требуют) блокировку, поэтому эти методы ничего не делают.233234#### `close()`235236Экземпляры [`Maildir`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Maildir) не держат открытых файлов, а нижележащие почтовые ящики не поддерживают блокировку, поэтому этот метод ничего не делает.237238#### `get_file(key)`239240В зависимости от платформы может быть невозможно изменить или удалить нижележащее сообщение, пока возвращенный файл остается открытым.241242> **См. также**243>244> **[Страница руководства maildir из qmail](https://python-all.ru/3.6/library/mailbox.html)**245>246> Оригинальная спецификация формата.247>248> **[Использование формата maildir](https://python-all.ru/3.6/library/mailbox.html)**249>250> Заметки о Maildir от его создателя. Включают обновлённую схему создания имён и детали семантики «info».251>252> **[man-страница maildir из Courier](https://python-all.ru/3.6/library/mailbox.html)**253>254> Другая спецификация формата. Описывает распространённое расширение для поддержки папок.255256### 19.4.1.2. [`mbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mbox)257258#### `class mailbox.mbox(path, factory=None, create=True)`259260Подкласс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате mbox. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равен `None`, в качестве представления сообщения по умолчанию используется [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage). Если *create* равен `True`, почтовый ящик создаётся, если он не существует.261262Формат mbox – это классический формат хранения почты в системах Unix. Все сообщения в почтовом ящике mbox хранятся в одном файле, при этом начало каждого сообщения обозначается строкой, первые пять символов которой – «From ».263264Существует несколько вариантов формата mbox, призванных устранить недостатки исходного. В целях совместимости [`mbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mbox) реализует исходный формат, иногда называемый *mboxo*. Это означает, что заголовок *Content-Length*, если он присутствует, игнорируется, а все вхождения «From » в начале строки тела сообщения преобразуются в «\>From » при сохранении сообщения, хотя вхождения «\>From » не преобразуются обратно в «From » при чтении сообщения.265266Некоторые методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), реализованные в [`mbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mbox), заслуживают особых замечаний:267268#### `get_file(key)`269270Использование файла после вызова `flush()` или `close()` для экземпляра [`mbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mbox) может привести к непредсказуемым результатам или вызвать исключение.271272#### `lock()`273274#### `unlock()`275276Используются три механизма блокировки: точечная блокировка (dot locking) и, если доступны, системные вызовы `flock()` и `lockf()`.277278> **См. также**279>280> **[Страница руководства mbox из qmail](https://python-all.ru/3.6/library/mailbox.html)**281>282> Спецификация формата и его разновидностей.283>284> **[Страница man mbox из tin](https://python-all.ru/3.6/library/mailbox.html)**285>286> Другая спецификация формата, с подробностями о блокировке.287>288> **[Настройка Netscape Mail в Unix: почему формат Content-Length плох](https://python-all.ru/3.6/library/mailbox.html)**289>290> Аргумент в пользу использования оригинального формата mbox, а не его вариации.291>292> **[«mbox» – это семейство нескольких взаимно несовместимых форматов почтовых ящиков](https://python-all.ru/3.6/library/mailbox.html)**293>294> История вариаций mbox.295296### 19.4.1.3. [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH)297298#### `class mailbox.MH(path, factory=None, create=True)`299300Подкласс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате MH. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равен `None`, в качестве представления сообщения по умолчанию используется [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage). Если *create* равен `True`, почтовый ящик создаётся, если он не существует.301302MH – это формат почтовых ящиков на основе каталогов, разработанный для MH Message Handling System, почтового клиента. Каждое сообщение в почтовом ящике MH находится в собственном файле. Почтовый ящик MH может содержать другие почтовые ящики MH (называемые *папками*) помимо сообщений. Папки могут быть вложены неограниченно. Почтовые ящики MH также поддерживают *последовательности* – именованные списки, используемые для логической группировки сообщений без их перемещения в подпапки. Последовательности определяются в файле с именем `.mh_sequences` в каждой папке.303304Класс [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH) управляет почтовыми ящиками MH, но не пытается эмулировать все поведения **mh**. В частности, он не изменяет и не зависит от файлов `context` и `.mh_profile`, которые используются программой **mh** для хранения своего состояния и конфигурации.305306Экземпляры [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH) имеют все методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), а также следующие:307308#### `list_folders()`309310Возвращает список имён всех папок.311312#### `get_folder(folder)`313314Возвращает экземпляр [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH), представляющий папку с именем *folder*. Исключение [`NoSuchMailboxError`](https://python-all.ru/3.6/library/mailbox.html#mailbox.NoSuchMailboxError) возникает, если папка не существует.315316#### `add_folder(folder)`317318Создаёт папку с именем *folder* и возвращает экземпляр [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH) представляющий её.319320#### `remove_folder(folder)`321322Удаляет папку с именем *folder*. Если папка содержит сообщения, будет возбуждено исключение [`NotEmptyError`](https://python-all.ru/3.6/library/mailbox.html#mailbox.NotEmptyError), и папка не будет удалена.323324#### `get_sequences()`325326Возвращает словарь, где имена последовательностей сопоставлены со списками ключей. Если последовательностей нет, возвращается пустой словарь.327328#### `set_sequences(sequences)`329330Переопределяет последовательности, существующие в почтовом ящике, на основе *sequences*, словаря, где имена сопоставлены со списками ключей, аналогично возвращаемому [`get_sequences()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH.get_sequences).331332#### `pack()`333334Переименовывает сообщения в почтовом ящике по мере необходимости для устранения пропусков в нумерации. Записи в списке последовательностей обновляются соответствующим образом.335336> **Примечание**337>338> Ранее выданные ключи становятся недействительными в результате этой операции и не должны использоваться в дальнейшем.339340Некоторые методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), реализованные в [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH), заслуживают особых замечаний:341342#### `remove(key)`343344#### `__delitem__(key)`345346#### `discard(key)`347348Эти методы немедленно удаляют сообщение. Соглашение MH помечать сообщение на удаление добавлением запятой к его имени не используется.349350#### `lock()`351352#### `unlock()`353354Используются три механизма блокировки: точечная блокировка и, если доступны, системные вызовы `flock()` и `lockf()`. Для почтовых ящиков MH блокировка почтового ящика означает блокировку файла `.mh_sequences` и, только на время любых операций, затрагивающих их, блокировку отдельных файлов сообщений.355356#### `get_file(key)`357358В зависимости от платформы может быть невозможно удалить базовое сообщение, пока возвращённый файл остаётся открытым.359360#### `flush()`361362Все изменения в почтовых ящиках MH применяются немедленно, поэтому этот метод ничего не делает.363364#### `close()`365366Экземпляры [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH) не держат открытых файлов, поэтому этот метод эквивалентен [`unlock()`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH.unlock).367368> **См. также**369>370> **[nmh – система обработки сообщений](https://python-all.ru/3.6/library/mailbox.html)**371>372> Домашняя страница **nmh**, обновлённой версии исходного **mh**.373>374> **[MH и nmh: электронная почта для пользователей и программистов](https://python-all.ru/3.6/library/mailbox.html)**375>376> Книга, лицензированная под GPL, о **mh** и **nmh**, с некоторой информацией о формате почтового ящика.377378### 19.4.1.4. [`Babyl`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Babyl)379380#### `class mailbox.Babyl(path, factory=None, create=True)`381382Подкласс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате Babyl. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя как открытое в бинарном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.383384Babyl – это однофайловый формат почтового ящика, используемый почтовым клиентом Rmail, входящим в состав Emacs. Начало сообщения обозначается строкой, содержащей два символа: Control-Подчёркивание (`'\037'`) и Control-L (`'\014'`). Конец сообщения обозначается началом следующего сообщения или, в случае последнего сообщения, строкой, содержащей символ Control-Подчёркивание (`'\037'`).385386Сообщения в почтовом ящике Babyl имеют два набора заголовков: исходные заголовки и так называемые видимые заголовки. Видимые заголовки обычно являются подмножеством исходных заголовков, которые были переформатированы или сокращены для большей привлекательности. Каждое сообщение в почтовом ящике Babyl также имеет сопутствующий список *меток* (коротких строк, которые записывают дополнительную информацию о сообщении), а список всех определённых пользователем меток, найденных в почтовом ящике, хранится в разделе параметров Babyl.387388Экземпляры [`Babyl`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Babyl) имеют все методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), а также следующие:389390#### `get_labels()`391392Возвращает список имён всех определённых пользователем меток, используемых в почтовом ящике.393394> **Примечание**395>396> Фактические сообщения проверяются для определения того, какие метки существуют в почтовом ящике, вместо обращения к списку меток в разделе параметров Babyl, но раздел Babyl обновляется при каждом изменении почтового ящика.397398Некоторые методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), реализованные в [`Babyl`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Babyl), заслуживают особых замечаний:399400#### `get_file(key)`401402В почтовых ящиках Babyl заголовки сообщения не хранятся непрерывно с телом сообщения. Чтобы создать файлоподобное представление, заголовки и тело копируются вместе в экземпляр [`io.BytesIO`](https://python-all.ru/3.6/library/io.html#io.BytesIO), API которого идентичен API файла. В результате файлоподобный объект полностью независим от нижележащего почтового ящика, но не экономит память по сравнению со строковым представлением.403404#### `lock()`405406#### `unlock()`407408Используются три механизма блокировки: точечная блокировка (dot locking) и, если доступны, системные вызовы `flock()` и `lockf()`.409410> **См. также**411>412> **[Формат файлов Babyl версии 5](https://python-all.ru/3.6/library/mailbox.html)**413>414> Спецификация формата Babyl.415>416> **[Чтение почты с помощью Rmail](https://python-all.ru/3.6/library/mailbox.html)**417>418> Руководство по Rmail, содержащее некоторую информацию о семантике Babyl.419420### 19.4.1.5. [`MMDF`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDF)421422#### `class mailbox.MMDF(path, factory=None, create=True)`423424Подкласс [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) для почтовых ящиков в формате MMDF. Параметр *factory* – это вызываемый объект, который принимает файлоподобное представление сообщения (ведущее себя так, как если бы оно было открыто в двоичном режиме) и возвращает пользовательское представление. Если *factory* равно `None`, в качестве представления сообщения по умолчанию используется [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage). Если *create* равно `True`, почтовый ящик создаётся, если он не существует.425426MMDF – это однофайловый формат почтового ящика, разработанный для Multichannel Memorandum Distribution Facility – агента пересылки почты. Каждое сообщение имеет ту же форму, что и сообщение mbox, но обрамляется строками, содержащими четыре символа Control-A (`'\001'`). Как и в формате mbox, начало каждого сообщения обозначается строкой, первые пять символов которой – «From », но дополнительные вхождения «From » не преобразуются в «\>From » при сохранении сообщений, так как дополнительные строки-разделители сообщений предотвращают ошибочный прием таких вхождений за начала последующих сообщений.427428Некоторые методы [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox), реализованные в [`MMDF`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDF), заслуживают особых замечаний:429430#### `get_file(key)`431432Использование файла после вызова `flush()` или `close()` для экземпляра [`MMDF`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDF) может привести к непредсказуемым результатам или вызвать исключение.433434#### `lock()`435436#### `unlock()`437438Используются три механизма блокировки: точечная блокировка (dot locking) и, если доступны, системные вызовы `flock()` и `lockf()`.439440> **См. также**441>442> **[страница руководства mmdf из tin](https://python-all.ru/3.6/library/mailbox.html)**443>444> Спецификация формата MMDF из документации tin, программы для чтения новостей.445>446> **[MMDF](https://python-all.ru/3.6/library/mailbox.html)**447>448> Статья в Википедии, описывающая Multichannel Memorandum Distribution Facility.449450## 19.4.2. [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) объекты451452#### `class mailbox.Message(message=None)`453454Подкласс [`email.message`](https://python-all.ru/3.6/library/email.message.html#module-email.message) модуля [`Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message). Подклассы [`mailbox.Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) добавляют состояние и поведение, специфичные для формата почтового ящика.455456Если *message* опущен, создаётся новый экземпляр в пустом состоянии по умолчанию. Если *message* – экземпляр [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message), его содержимое копируется; кроме того, любая форматозависимая информация преобразуется настолько, насколько это возможно, если *message* является экземпляром [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message). Если *message* – строка, байтовая строка или файл, он должен содержать сообщение, совместимое с [**RFC 2822**](https://python-all.ru/3.6/library/mailbox.html), которое читается и разбирается. Файлы должны быть открыты в бинарном режиме, но текстовые файлы принимаются для обратной совместимости.457458Формат-специфичные состояния и поведение, предоставляемые подклассами, различаются, но в целом поддерживаются только те свойства, которые не привязаны к конкретному почтовому ящику (хотя, предположительно, эти свойства специфичны для конкретного формата почтового ящика). Например, смещения в файлах для однофайловых форматов почтовых ящиков и имена файлов для форматов на основе каталогов не сохраняются, так как они применимы только к исходному почтовому ящику. Но такие состояния, как было ли сообщение прочитано пользователем или помечено как важное, сохраняются, поскольку они относятся к самому сообщению.459460Нет требования, чтобы экземпляры [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) использовались для представления сообщений, полученных с помощью экземпляров [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox). В некоторых ситуациях время и память, необходимые для создания представлений [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), могут оказаться неприемлемыми. Для таких случаев экземпляры [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) также предлагают строковые и файлоподобные представления, а пользовательская фабрика сообщений может быть указана при инициализации экземпляра [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox).461462### 19.4.2.1. [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage)463464#### `class mailbox.MaildirMessage(message=None)`465466Сообщение с поведением, специфичным для Maildir. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message).467468Обычно почтовый клиент перемещает все сообщения из подкаталога `new` в подкаталог `cur` после того, как пользователь впервые открывает и закрывает почтовый ящик, отмечая, что сообщения старые, независимо от того, были ли они фактически прочитаны. Каждое сообщение в `cur` имеет раздел «info», добавленный к его имени файла для хранения информации о его состоянии. (Некоторые почтовые программы могут также добавлять раздел «info» к сообщениям в `new`.) Раздел «info» может принимать одну из двух форм: он может содержать «2,» с последующим списком стандартизированных флагов (например, «2,FR») или может содержать «1,» с последующей так называемой экспериментальной информацией. Стандартные флаги для сообщений Maildir следующие:469470| Флаг | Значение | Пояснение |471| --- | --- | --- |472| D | Черновик | В процессе составления |473| F | Помечено | Помечено как важное |474| P | Передан | Переслано, отправлено повторно или возвращено |475| R | Отвечено | Получен ответ |476| S | Просмотрено | Прочитано |477| T | Удалено | Помечено для последующего удаления |478479Экземпляры [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) предоставляют следующие методы:480481#### `get_subdir()`482483Возвращает «new» (если сообщение должно храниться в подкаталоге `new` или «cur» (если сообщение должно храниться в подкаталоге `cur`).484485> **Примечание**486>487> Сообщение обычно перемещается из `new` в `cur` после того, как к его почтовому ящику был получен доступ, независимо от того, было ли сообщение прочитано. Сообщение `msg` считается прочитанным, если `"S" in msg.get_flags()` равно `True`.488489#### `set_subdir(subdir)`490491Устанавливает подкаталог, в котором должно храниться сообщение. Параметр *subdir* должен быть либо «new», либо «cur».492493#### `get_flags()`494495Возвращает строку, указывающую текущие установленные флаги. Если сообщение соответствует стандартному формату Maildir, результатом является конкатенация в алфавитном порядке нуля или одного вхождения каждого из `'D'`, `'F'`, `'P'`, `'R'`, `'S'` и `'T'`. Возвращается пустая строка, если флаги не установлены или если «info» содержит экспериментальную семантику.496497#### `set_flags(flags)`498499Устанавливает флаги, указанные *flags*, и сбрасывает все остальные.500501#### `add_flag(flag)`502503Устанавливает флаг(и), указанные *flag*, не изменяя остальные флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа. Текущий «info» перезаписывается, независимо от того, содержит ли он экспериментальную информацию вместо флагов.504505#### `remove_flag(flag)`506507Сбрасывает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы удалить несколько флагов за раз, *flag* может быть строкой из более чем одного символа. Если «info» содержит экспериментальную информацию, а не флаги, текущий «info» не изменяется.508509#### `get_date()`510511Возвращает дату доставки сообщения в виде числа с плавающей запятой, представляющего количество секунд с начала эпохи.512513#### `set_date(date)`514515Устанавливает дату доставки сообщения в *date*, число с плавающей запятой, представляющее количество секунд с начала эпохи.516517#### `get_info()`518519Возвращает строку, содержащую «info» для сообщения. Это полезно для доступа к экспериментальному «info» и его изменения (т.е. не являющегося списком флагов).520521#### `set_info(info)`522523Устанавливает «info» в *info*, которое должно быть строкой.524525Когда экземпляр [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) создаётся на основе экземпляра [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и происходят следующие преобразования:526527| Результирующее состояние | [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) состояние |528| --- | --- |529| Подкаталог «cur» | Флаг O |530| Флаг F | Флаг F |531| Флаг R | Флаг A |532| Флаг S | Флаг R |533| Флаг T | Флаг D |534535Когда экземпляр [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:536537| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) |538| --- | --- |539| Подкаталог «cur» | последовательность «unseen» |540| подкаталог «cur» и флаг S | нет последовательности «unseen» |541| Флаг F | последовательность «flagged» |542| Флаг R | последовательность «replied» |543544Когда экземпляр [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:545546| Результирующее состояние | Состояние [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) |547| --- | --- |548| Подкаталог «cur» | метка «unseen» |549| подкаталог «cur» и флаг S | нет метки «unseen» |550| Флаг P | метка «forwarded» или «resent» |551| Флаг R | метка «отвечено» |552| Флаг T | метка «удалено» |553554### 19.4.2.2. [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage)555556#### `class mailbox.mboxMessage(message=None)`557558Сообщение с поведением, специфичным для mbox. Параметр *message* имеет тот же смысл, что и в конструкторе [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message).559560Сообщения в почтовом ящике mbox хранятся вместе в одном файле. Адрес отправителя (envelope address) и время доставки обычно хранятся в строке, начинающейся с «From », которая используется для обозначения начала сообщения, хотя точный формат этих данных сильно различается в разных реализациях mbox. Флаги, указывающие на состояние сообщения, такие как прочитано или помечено как важное, обычно хранятся в заголовках *Status* и *X-Status*.561562Обычные флаги для сообщений mbox:563564| Флаг | Значение | Пояснение |565| --- | --- | --- |566| R | Прочитано | Прочитано |567| O | Старое | Ранее обнаружено почтовым клиентом |568| D | Удалено | Помечено для последующего удаления |569| F | Помечено | Помечено как важное |570| A | Отвечено | Получен ответ |571572Флаги «R» и «O» хранятся в заголовке *Status*, а флаги «D», «F» и «A» – в заголовке *X-Status*. Флаги и заголовки обычно располагаются в указанном порядке.573574Экземпляры [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) предоставляют следующие методы:575576#### `get_from()`577578Возвращает строку, представляющую строку «From », отмечающую начало сообщения в почтовом ящике mbox. Начальная «From » и конечный символ новой строки исключаются.579580#### `set_from(from_, time_=None)`581582Устанавливает строку «From » равной *from\_*, которая должна быть указана без начальной «From » или конечного символа новой строки. Для удобства можно указать *time\_*, и она будет правильно отформатирована и добавлена к *from\_*. Если *time\_* указан, это должен быть экземпляр [`time.struct_time`](https://python-all.ru/3.6/library/time.html#time.struct_time), кортеж, подходящий для передачи в [`time.strftime()`](https://python-all.ru/3.6/library/time.html#time.strftime), или `True` (для использования [`time.gmtime()`](https://python-all.ru/3.6/library/time.html#time.gmtime)).583584#### `get_flags()`585586Возвращает строку, указывающую установленные флаги. Если сообщение соответствует стандартному формату, результатом является конкатенация в следующем порядке нуля или одного вхождения каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.587588#### `set_flags(flags)`589590Устанавливает флаги, указанные в *flags*, и снимает все остальные. Параметр *flags* должен быть конкатенацией в произвольном порядке нуля или более вхождений каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.591592#### `add_flag(flag)`593594Устанавливает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа.595596#### `remove_flag(flag)`597598Снимает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы снять несколько флагов одновременно, *flag* может быть строкой из более чем одного символа.599600Когда экземпляр [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) создается на основе экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), строка «From » генерируется на основе даты доставки экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), и происходят следующие преобразования:601602| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) |603| --- | --- |604| Флаг R | Флаг S |605| Флаг O | Подкаталог «cur» |606| Флаг D | Флаг T |607| Флаг F | Флаг F |608| Флаг A | Флаг R |609610Когда экземпляр [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:611612| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) |613| --- | --- |614| Флаг R и флаг O | нет последовательности «unseen» |615| Флаг O | последовательность «unseen» |616| Флаг F | последовательность «flagged» |617| Флаг A | последовательность «replied» |618619Когда экземпляр [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:620621| Результирующее состояние | Состояние [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) |622| --- | --- |623| Флаг R и флаг O | нет метки «unseen» |624| Флаг O | метка «unseen» |625| Флаг D | метка «удалено» |626| Флаг A | метка «отвечено» |627628Когда экземпляр [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message) создается на основе экземпляра [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage), строка «From » копируется, и все флаги напрямую соответствуют:629630| Результирующее состояние | Состояние [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) |631| --- | --- |632| Флаг R | Флаг R |633| Флаг O | Флаг O |634| Флаг D | Флаг D |635| Флаг F | Флаг F |636| Флаг A | Флаг A |637638### 19.4.2.3. [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage)639640#### `class mailbox.MHMessage(message=None)`641642Сообщение с поведением, характерным для MH. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message).643644Сообщения MH не поддерживают метки и флаги в традиционном понимании, но поддерживают последовательности – логические группировки произвольных сообщений. Некоторые почтовые программы (хотя не стандартные **mh** и **nmh**) используют последовательности примерно так же, как флаги используются в других форматах:645646| Последовательность | Пояснение |647| --- | --- |648| непрочитанное | Не прочитано, но ранее обнаружено почтовым клиентом (MUA) |649| отвечено | Получен ответ |650| помечено | Помечено как важное |651652Экземпляры [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) предоставляют следующие методы:653654#### `get_sequences()`655656Возвращает список имен последовательностей, которые включают это сообщение.657658#### `set_sequences(sequences)`659660Устанавливает список последовательностей, которые включают это сообщение.661662#### `add_sequence(sequence)`663664Добавляет *sequence* в список последовательностей, которые включают это сообщение.665666#### `remove_sequence(sequence)`667668Удаляет *sequence* из списка последовательностей, которые включают это сообщение.669670Когда экземпляр [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) создаётся на основе экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), происходят следующие преобразования:671672| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) |673| --- | --- |674| последовательность «unseen» | нет флага S |675| последовательность «replied» | Флаг R |676| последовательность «flagged» | Флаг F |677678Когда экземпляр [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) создается на основе экземпляра [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и происходят следующие преобразования:679680| Результирующее состояние | [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) состояние |681| --- | --- |682| последовательность «unseen» | нет флага R |683| последовательность «replied» | Флаг A |684| последовательность «flagged» | Флаг F |685686Когда экземпляр [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:687688| Результирующее состояние | Состояние [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) |689| --- | --- |690| последовательность «unseen» | метка «unseen» |691| последовательность «replied» | метка «отвечено» |692693### 19.4.2.4. [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage)694695#### `class mailbox.BabylMessage(message=None)`696697Сообщение с поведением, специфичным для Babyl. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message).698699Некоторые метки сообщений, называемые *attributes*, по соглашению имеют специальное значение. Атрибуты следующие:700701| Метка | Пояснение |702| --- | --- |703| непрочитанное | Не прочитано, но ранее обнаружено почтовым клиентом (MUA) |704| удалено | Помечено для последующего удаления |705| архивировано | Скопировано в другой файл или почтовый ящик |706| отвечено | Получен ответ |707| переслано | Переслано |708| изменено | Изменено пользователем |709| переотправлено | Отправлено повторно |710711По умолчанию Rmail отображает только видимые заголовки. Однако класс [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) использует исходные заголовки, поскольку они более полны. При желании к видимым заголовкам можно обратиться явно.712713Экземпляры [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) предоставляют следующие методы:714715#### `get_labels()`716717Возвращает список меток сообщения.718719#### `set_labels(labels)`720721Устанавливает список меток сообщения равным *labels*.722723#### `add_label(label)`724725Добавляет метку *label* в список меток сообщения.726727#### `remove_label(label)`728729Удаляет метку *label* из списка меток сообщения.730731#### `get_visible()`732733Возвращает экземпляр [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), содержащий видимые заголовки сообщения и пустое тело.734735#### `set_visible(visible)`736737Устанавливает видимые заголовки сообщения такими же, как заголовки из *message*. Параметр *visible* должен быть экземпляром [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message), экземпляром [`email.message.Message`](https://python-all.ru/3.6/library/email.compat32-message.html#email.message.Message), строкой или файлоподобным объектом (который должен быть открыт в текстовом режиме).738739#### `update_visible()`740741Когда исходные заголовки экземпляра [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) изменяются, видимые заголовки автоматически не изменяются для соответствия. Этот метод обновляет видимые заголовки следующим образом: каждый видимый заголовок с соответствующим исходным заголовком устанавливается в значение исходного заголовка, каждый видимый заголовок без соответствующего исходного заголовка удаляется, а любые из *Date*, *From*, *Reply-To*, *To*, *CC* и *Subject*, которые присутствуют в исходных заголовках, но отсутствуют в видимых заголовках, добавляются к видимым заголовкам.742743Когда экземпляр [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) создаётся на основе экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), происходят следующие преобразования:744745| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) |746| --- | --- |747| метка «unseen» | нет флага S |748| метка «удалено» | Флаг T |749| метка «отвечено» | Флаг R |750| Метка «forwarded» | Флаг P |751752Когда экземпляр [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) создаётся на основе экземпляра [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage), заголовки *Status* и *X-Status* опускаются и происходят следующие преобразования:753754| Результирующее состояние | [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) или [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) состояние |755| --- | --- |756| метка «unseen» | нет флага R |757| метка «удалено» | Флаг D |758| метка «отвечено» | Флаг A |759760Когда экземпляр [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:761762| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) |763| --- | --- |764| метка «unseen» | последовательность «unseen» |765| метка «отвечено» | последовательность «replied» |766767### 19.4.2.5. [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage)768769#### `class mailbox.MMDFMessage(message=None)`770771Сообщение с поведением, специфичным для MMDF. Параметр *message* имеет то же значение, что и в конструкторе [`Message`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Message).772773Как и сообщения в почтовом ящике mbox, сообщения MMDF хранятся с адресом отправителя и датой доставки в начальной строке, начинающейся с «From ». Аналогично, флаги, указывающие на состояние сообщения, обычно хранятся в заголовках *Status* и *X-Status*.774775Стандартные флаги для сообщений MMDF совпадают с флагами сообщений mbox и перечислены ниже:776777| Флаг | Значение | Пояснение |778| --- | --- | --- |779| R | Прочитано | Прочитано |780| O | Старое | Ранее обнаружено почтовым клиентом |781| D | Удалено | Помечено для последующего удаления |782| F | Помечено | Помечено как важное |783| A | Отвечено | Получен ответ |784785Флаги «R» и «O» хранятся в заголовке *Status*, а флаги «D», «F» и «A» – в заголовке *X-Status*. Флаги и заголовки обычно располагаются в указанном порядке.786787Экземпляры [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) предоставляют следующие методы, идентичные методам, предоставляемым [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage):788789#### `get_from()`790791Возвращает строку, представляющую строку «From », отмечающую начало сообщения в почтовом ящике mbox. Начальная «From » и конечный символ новой строки исключаются.792793#### `set_from(from_, time_=None)`794795Устанавливает строку «From » равной *from\_*, которая должна быть указана без начальной «From » или конечного символа новой строки. Для удобства можно указать *time\_*, и она будет правильно отформатирована и добавлена к *from\_*. Если *time\_* указан, это должен быть экземпляр [`time.struct_time`](https://python-all.ru/3.6/library/time.html#time.struct_time), кортеж, подходящий для передачи в [`time.strftime()`](https://python-all.ru/3.6/library/time.html#time.strftime), или `True` (для использования [`time.gmtime()`](https://python-all.ru/3.6/library/time.html#time.gmtime)).796797#### `get_flags()`798799Возвращает строку, указывающую установленные флаги. Если сообщение соответствует стандартному формату, результатом является конкатенация в следующем порядке нуля или одного вхождения каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.800801#### `set_flags(flags)`802803Устанавливает флаги, указанные в *flags*, и снимает все остальные. Параметр *flags* должен быть конкатенацией в произвольном порядке нуля или более вхождений каждого из `'R'`, `'O'`, `'D'`, `'F'` и `'A'`.804805#### `add_flag(flag)`806807Устанавливает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы добавить более одного флага за раз, *flag* может быть строкой из более чем одного символа.808809#### `remove_flag(flag)`810811Снимает флаг(и), указанные в *flag*, не изменяя другие флаги. Чтобы снять несколько флагов одновременно, *flag* может быть строкой из более чем одного символа.812813Когда экземпляр [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) создается на основе экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), строка «From » генерируется на основе даты доставки экземпляра [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage), и происходят следующие преобразования:814815| Результирующее состояние | Состояние [`MaildirMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MaildirMessage) |816| --- | --- |817| Флаг R | Флаг S |818| Флаг O | Подкаталог «cur» |819| Флаг D | Флаг T |820| Флаг F | Флаг F |821| Флаг A | Флаг R |822823Когда экземпляр [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) создаётся на основе экземпляра [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage), происходят следующие преобразования:824825| Результирующее состояние | Состояние [`MHMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MHMessage) |826| --- | --- |827| Флаг R и флаг O | нет последовательности «unseen» |828| Флаг O | последовательность «unseen» |829| Флаг F | последовательность «flagged» |830| Флаг A | последовательность «replied» |831832Когда экземпляр [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) создаётся на основе экземпляра [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage), происходят следующие преобразования:833834| Результирующее состояние | Состояние [`BabylMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.BabylMessage) |835| --- | --- |836| Флаг R и флаг O | нет метки «unseen» |837| Флаг O | метка «unseen» |838| Флаг D | метка «удалено» |839| Флаг A | метка «отвечено» |840841Когда экземпляр [`MMDFMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MMDFMessage) создается на основе экземпляра [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage), строка «From » копируется, и все флаги напрямую соответствуют:842843| Результирующее состояние | Состояние [`mboxMessage`](https://python-all.ru/3.6/library/mailbox.html#mailbox.mboxMessage) |844| --- | --- |845| Флаг R | Флаг R |846| Флаг O | Флаг O |847| Флаг D | Флаг D |848| Флаг F | Флаг F |849| Флаг A | Флаг A |850851## 19.4.3. Исключения852853В модуле [`mailbox`](https://python-all.ru/3.6/library/mailbox.html#module-mailbox) определены следующие классы исключений:854855#### `exception mailbox.Error`856857Базовый класс для всех остальных исключений, специфичных для модуля.858859#### `exception mailbox.NoSuchMailboxError`860861Вызывается, когда ожидается почтовый ящик, но он не найден, например, при создании экземпляра подкласса [`Mailbox`](https://python-all.ru/3.6/library/mailbox.html#mailbox.Mailbox) с несуществующим путём (и с параметром *create*, установленным в `False`) или при открытии несуществующей папки.862863#### `exception mailbox.NotEmptyError`864865Вызывается, когда почтовый ящик не пуст, но ожидается пустым, например, при удалении папки, содержащей сообщения.866867#### `exception mailbox.ExternalClashError`868869Возникает, когда не зависящее от программы условие, связанное с почтовым ящиком, не позволяет продолжить работу, например, когда не удаётся получить блокировку, которая уже удерживается другой программой, или когда сгенерированное уникальное имя файла уже существует.870871#### `exception mailbox.FormatError`872873Вызывается, когда данные в файле не могут быть разобраны, например, когда экземпляр [`MH`](https://python-all.ru/3.6/library/mailbox.html#mailbox.MH) пытается прочитать повреждённый файл `.mh_sequences`.874875## 19.4.4. Примеры876877Простой пример вывода тем всех сообщений в почтовом ящике, которые кажутся интересными:878879```python880import mailbox881for message in mailbox.mbox('~/mbox'):882    subject = message['subject']       # Может быть None.883    if subject and 'python' in subject.lower():884        print(subject)885```886887Чтобы скопировать все письма из почтового ящика Babyl в почтовый ящик MH, преобразуя всю форматно-специфичную информацию, которую можно преобразовать:888889```python890import mailbox891destination = mailbox.MH('~/Mail')892destination.lock()893for message in mailbox.Babyl('~/RMAIL'):894    destination.add(mailbox.MHMessage(message))895destination.flush()896destination.unlock()897```898899Этот пример сортирует письма из нескольких списков рассылки по разным почтовым ящикам, стараясь избежать повреждения писем из-за одновременного изменения другими программами, потери писем из-за прерывания программы или преждевременного завершения из-за повреждённых сообщений в почтовом ящике:900901```python902import mailbox903import email.errors904905list_names = ('python-list', 'python-dev', 'python-bugs')906907boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names}908inbox = mailbox.Maildir('~/Maildir', factory=None)909910for key in inbox.iterkeys():911    try:912        message = inbox[key]913    except email.errors.MessageParseError:914        continue                # Сообщение повреждено. Просто оставьте его.915916    for name in list_names:917        list_id = message['list-id']918        if list_id and name in list_id:919            # Получить почтовый ящик для использования.920            box = boxes[name]921922            # Записать копию на диск перед удалением оригинала.923            # Если произошёл сбой, возможно дублирование сообщения, но924            # это лучше, чем полная потеря сообщения.925            box.lock()926            box.add(message)927            box.flush()928            box.unlock()929930            # Удалить исходное сообщение931            inbox.lock()932            inbox.discard(key)933            inbox.flush()934            inbox.unlock()935            break               # Целевой получатель найден, поиск прекращён.936937for box in boxes.itervalues():938    box.close()939```940