Maildir

class mailbox.Maildir (dirname, factory=None, create=True）

用于Maildir格式的邮箱的Mailbox的子类。参数factory是一个可调用的对象，它接受类似文件的消息表示（其行为就像在二进制模式下打开一样）并返回一个自定义表示。如果factory是None, MaildirMessage用作默认的消息表示。如果create是True，那么邮箱会被创建，如果它是notexist

由于历史原因，dirname被命名为而不是path.

Maildir是为qmail mailtransfer代理发明的基于目录的邮箱格式，现在受到其他程序的广泛支持。aMaildir邮箱中的消息存储在公共directorystructure中的单独文件中。这种设计允许Maildir邮箱被多个不相关的程序访问和修改而不会损坏数据，因此文件锁定是不必要的.

Maildir邮箱包含三个子目录，即：tmp,new和cur。消息在tmp子目录中暂时创建，然后移动到new子目录tofinalize delivery。邮件用户代理可能随后将邮件移至cur子目录，并在其文件名附加的特殊“信息”部分中存储有关消息状态的信息.

还支持Courier邮件传输代理引入的样式的文件夹。如果"."是其名称中的第一个字符，则主邮箱的任何子目录都被视为文件夹。文件夹名称由Maildir表示，没有前导"."。每个文件夹本身都是Maildirmailbox，但不应包含其他文件夹。相反，使用"."指示逻辑嵌套来划分级别，例如“Archived.2005.07”.

注意

Maildir规范要求使用冒号（":"）在某些消息文件名中。但是，某些操作系统不允许在文件名中使用此字符。如果您希望在suchan操作系统上使用类似Maildir的格式，则应指定另一个字符来使用。感叹号（"!"）是一个受欢迎的选择。例如：

import mailboxmailbox.Maildir.colon = "!"

colon属性也可以基于每个实例设置.

Maildir实例具有Mailbox的所有方法，除了以下内容：

list_folders（）

返回所有文件夹的名称列表.

get_folder（folder）

返回Maildir表示名称为的文件夹的实例folder。一个 NoSuchMailboxError如果文件夹不存在则引发异常.

add_folder（folder）

创建一个名为folder的文件夹并返回一个表示它的Maildir实例.

remove_folder (folder)

删除名称为folder的文件夹。如果文件夹包含任何消息，则NotEmptyError异常将被提出，文件夹将不被删除.

clean ( )

从邮箱中删除过去36小时内未访问过的临时文件。Maildir规范说邮件阅读程序应该偶尔这样做.

有些Mailbox由Maildir实现的方法值得特别说明：

add（message）

__setitem__（key, message）

update（arg）

警告

这些方法基于当前processID生成唯一的文件名。使用多个线程时，可能会发生未检测到的名称冲突并导致邮箱损坏，除非协调线程以避免使用这些方法同时操作同一邮箱.

flush ( )

对Maildir邮箱的所有更改都会立即应用，所以这个方法什么都不用.

lock ()

unlock ()

Maildir mailboxes不支持（或要求）锁定，所以这些方法没有.

close (）

Maildir实例不保留任何打开文件，底层邮箱不支持锁定，所以这个方法什么都不做.

get_file (key)

根据主机平台，当返回的文件保持打开状态时，可能无法修改或删除基础消息.

mbox

class mailbox.mbox (path, factory=None, create=True)

对于mbox格式的邮箱，Mailbox的子类。参数factory是一个可调用的对象，它接受类似文件的消息表示（就像在二进制模式下打开一样）并返回一个自定义表示。如果factory是None, mboxMessage用作默认的消息表示。如果create是True，则创建邮箱如果它是notexist

这是mbox格式是在Unix系统上存储邮件的经典格式。mbox邮箱中的所有消息都存储在一个文件中，每行消息的开头由一行表示，其前五个字符为“From”.

存在mbox格式的几种变体以解决原始中的感知缺陷。为了兼容性，mbox实现原始格式，有时也称为mboxo。这意味着Content-Length标题（如果存在）被忽略，并且当存储消息时，消息体中一行开头的“From”的任何发生都转换为“＆gt; From”，尽管“＆gt; From”的出现不会转换为“From”“在阅读信息时

一些Mailbox由mbox实现的方法值得特别说明：

get_file（key）

在调用flush()后使用该文件close() mbox实例可能会产生不可预测的结果或引起异常情况.

lock (）

unlock ()

使用三种锁定机制锁定，如果有的话，flock()和lockf()系统调用.

MH

class mailbox.MH（path, factory=None, create=True）

对于MH格式的邮箱，Mailbox的子类。参数factory是一个可调用的对象，它接受类似文件的消息表示（就像在二进制模式下打开一样）并返回一个自定义表示。如果factory是None, MHMessage用作默认的消息表示。如果create是True，则创建邮箱如果它是notexist

//MH是为邮件用户代理MH Message HandlingSystem发明的基于目录的邮箱格式。MH邮箱中的每条消息都驻留在自己的文件中。除邮件外，MH邮箱还可以包含其他MH邮箱（称为folders）。文件夹可以无限期嵌套。MH邮箱也支持sequences，它们是用于逻辑分组消息而不将其移动到子文件夹的命名列表。序列在文件中定义.mh_sequences在每个文件夹中

MHclass操纵MH邮箱，但它不会尝试编写所有MH 的行为。特别是它不会修改并且不受context或.mh_profile用于存储其状态和配置的或文件的影响.

MH实例具有Mailbox的所有方法以及以下内容：

list_folders（）

返回所有文件夹的名称列表.

get_folder（folder）

返回MH表示名称为的文件夹的实例folder。一个 NoSuchMailboxError如果文件夹不存在则引发异常.

add_folder（folder）

创建一个名为folder并返回MH实例代表它

remove_folder（folder）

删除名称为的文件夹folder。如果文件夹包含任何消息，则NotEmptyError异常将被提出，文件夹将不会被删除.

get_sequences（）

返回映射到键列表的序列名称字典。如果有序列，则返回空字典.

set_sequences (sequences )

根据sequences，一个映射到键列表的名称字典，如get_sequences().

pack（）

根据需要重命名邮箱中的邮件，以消除数据中的空白。序列表中的条目相应更新.

注意

已经发出的密钥被此操作无效，不应随后使用.

有些Mailbox由MH实现的方法值得特别说明：

remove（key）

__delitem__（key）

discard（key）

这些方法会立即删除该消息。通过在其名称前加上逗号来标记要删除的消息的MH约定不被使用.

lock (）

unlock (）

使用三种锁定机制 – 点锁定，如果可用的话，使用flock()和lockf()系统调用。对于MH邮箱，锁定邮箱意味着锁定.mh_sequences文件，并且，仅在影响它们的任何操作的持续时间内，锁定单个消息文件.

get_file (key )

根据主机平台，当返回的文件保持打开状态时，可能无法删除底层消息.

flush ( )

对MH邮箱的所有更改都会立即应用，因此该方法无效.

close()

MH实例不保留任何打开文件，因此此方法等效于unlock().

Babyl

class mailbox.Babyl（path, factory=None, create=True）

的子类Mailbox对于Babyl格式的邮箱。参数factory是一个可调用的对象，它接受类似文件的消息表示（其行为就像在二进制模式下打开一样）并返回一个自定义表示。如果factory是None, BabylMessage用作默认的messagerepresentation。如果create是True，则创建邮箱如果它是notexist

Babyl是由Emacs包含的Rmail邮件用户代理使用的单文件邮箱格式。消息的开头由包含两个字符Control-Underscore（"\037"）和Control-L（"\014"）的行指示。消息的结尾由nextwssage的开头指示，或者在最后一条消息的情况下，包含aControl-Underscore（"\037"）字符的行

在Babyl邮箱中的消息有两组标题，原始标题和所谓的可见标题。可见标题通常是原始标题的一个子集，已经重新格式化或删节以使其更具吸引力。Babyl邮箱中的每条消息还有一个labels的附带列表，或者记录有关themessage的额外信息的短字符串，并且在Babyl选项部分中保留了邮箱中找到的所有用户定义标签的列表.

Babyl实例具有Mailbox的所有方法，除了以下内容：

get_labels（）

//返回邮箱中使用的所有用户定义标签的名称列表.

注意

检查实际的消息以确定邮箱中存在哪些标签，而不是查阅Babyloptions部分中的标签列表，但每当邮箱被修改时，Babyl部分都会更新.

一些Mailbox由Babyl实现的方法值得特别说明：

get_file（key）

在Babyl邮箱中，邮件的标题不会与邮件正文相连。要生成类似文件的表示，将标题和正文一起复制到io.BytesIO实例，其API与afile相同。因此，类似文件的对象真正独立于底层邮箱，但与字符串表示相比不会节省内存.

lock（）

unlock（）

使用三种锁定机构 – 点锁定，如果有的话，flock()和lockf()系统调用

MMDF

class mailbox.MMDF（path, factory=None, create=True）

的子类Mailbox对于MMDF格式的邮箱。参数factory是一个可调用的对象，它接受类似文件的消息表示（就像在二进制模式下打开一样）并返回一个自定义表示。如果factory是None, MMDFMessage用作默认的messagerepresentation。如果create是True，那么邮箱会被创建，如果它是notexist的

MMDF是为多渠道备忘录分发工具（一种邮件传输代理）发明的单文件邮箱格式。每条消息与mbox消息的形式相同，但在包含四个Control-A的行之前和之后被括起来（"\001"）人物。与mbox格式一样，每条消息的开始由一行表示，其前五个字符为“From”，但在存储消息时，“From”的其他出现不会转换为“＆gt; From”，因为额外的消息分隔符行会防止错误后续消息开始的事件.

一些Mailbox由MMDF实现的方法值得特别说明：

get_file（key）

在调用flush()后使用该文件close() MMDF实例可能会产生不可预测的结果或引起异常情况.

lock (）

unlock ()

使用三种锁定机制锁定，如果有的话，flock()和lockf()系统调用.

MaildirMessage

class mailbox.MaildirMessage(message=None）

具有Maildir特定行为的消息。参数message与Message构造函数具有相同的意义.

通常，邮件用户代理应用程序将new子目录中的所有消息移动到cur子目录在用户第一次打开和关闭邮箱后，记录邮件是否旧，他们实际上是否已被阅读。cur中的每条消息都在其文件名中添加了“info”部分，以存储有关其状态的信息。（某些邮件阅读器也可能在new中的消息中添加“info”部分。）“信息”部分可以采用两种形式中的一种：它可以包含“2”，后面是标准化标志列表（例如，“2，FR”），或者它可以包含“1”，然后是所谓的实验信息。Maildir信息的标准标志如下：

标志	含义	说明
D	草稿	作品
F	标记	标记为重要
P	通过	转发，怨恨或反弹
ř	回复	的子类回复
S	看	读
Ť	丢弃	标记为后续删除

MaildirMessage实例提供以下方法：

get_subdir（）

返回“新”（如果消息应存储在new子目录）或“cur”（如果消息应该存储在cur子目录）.

注意

消息通常是从new至 cur访问了其邮箱后，无论邮件是否已被阅读。如果msg是"S" in msg.get_flags()（True.

set_subdir）subdir，则会显示

设置应存储消息的子目录。参数subdir必须是“new”或“cur”.

get_flags ( )

返回一个字符串，指定当前设置的标志。如果themessage符合标准的Maildir格式，则结果是按字母顺序排列，每个字符为零或一次"D", "F", "P", "R", "S"，和"T"。如果没有设置标志或者“info”包含experimentalsemantics，则返回空字符串.

set_flags (flags)

设置flags指定的标志并取消设置所有其他人。

add_flag（flag）

设置flag指定的标志而不更改其他标志。要一次添加多个标志，flag可能是一个超过一个字符的字符串。无论是否包含实验信息而不是旗帜，当前的“信息”都会被覆盖.

remove_flag（flag）

取消设置flag没有改变其他标志。要一次删除多个标志，flag也许是一个多个字符的字符串。如果“info”包含实验信息而不是标志，则当前的“info”不会被修改.

get_date ( )

将消息的发送日期作为浮点数表示，代表自纪元以来的秒数.

set_date (date)

将消息的发送日期设置为date，一个代表自纪元以来秒数的浮点数

get_info ()

返回包含消息“info”的字符串。这对于实现（即不是列表offlags）的“信息”非常有用.

set_info（info）

将“info”设置为info，应该是一个字符串.

当MaildirMessage实例基于mboxMessage或MMDFMessage实例创建时，Status和X-Status标题被省略，下面的转换位置：

当MaildirMessage实例基于MHMessage实例创建时，发生以下转换：

当基于MaildirMessage实例创建BabylMessage实例时，会发生以下转换：

mboxMessage

class mailbox.mboxMessage（message=None）

包含mbox特定行为的消息。参数message与Message构造函数具有相同的含义.

mbox邮箱中的消息一起存储在一个文件中。Thesender的信封地址和传送时间通常存储在aline中，以“From”开头，用于指示消息的开始，尽管这些数据的实际格式存在很大差异。指示消息状态的标志，例如它是否已被读取或标记为重要，通常存储在Status和X-Status headers.

mbox消息的常规标志中如下：

标志	含义	说明
R	阅读	阅读
O	老	以前被MUA发现
D	删除	标记为后续删除
F	标记	标记为重要
A	回答	回复

“R”和“O”标志存储在Status标题中，“D”，“F”，并且“A”标志存储在X-Status标题中。标志和标题通常按照提到的顺序出现.

mboxMessage实例提供以下方法：

get_from（）

返回表示“From”的字符串标记mbox邮箱中的themessage开头的行。领先的“从”和后面的换行排除.

set_from (from_, time_=None)

将“从”行设置为from_，应该指定aleading“From”或尾随换行符。为方便起见，可以指定time_并将其格式化并附加到from_。如果指定了time_，它应该是time.struct_time实例，适合传递给time.strftime()或True的atup（使用time.gmtime()）.

get_flags（）

返回一个字符串，指定当前设置的标志。如果themessage符合传统格式，则结果是按 的每个零或一次出现的顺序进行连接"R", "O", "D", "F"和"A".

set_flags（flags）

设置flags指定的标志并取消所有其他标志。参数flags应该是"R", "O", "D", "F"和"A".

add_flag（flag）

设置flag指定的标志而不更改其他标志。要一次添加多个标志，flag可能是一个多个字符的字符串.

remove_flag(flag)

取消设置flag指定的标志而不更改其他标志。Toremove一次不止一个标志，flag也许是一串多个字符

当mboxMessage实例是基于MaildirMessage实例创建的，根据MaildirMessage实例的交付日期生成“From”行，以及以下转换前置位置：

当mboxMessage实例是基于MHMessage例如，发生以下转换：

当mboxMessage实例基于BabylMessage实例创建时，发生以下转换：

当Message实例是基于MMDFMessage例如，复制“From”行并且所有标志直接对应：

MHMessage

class mailbox.MHMessage（message=None）

具有MH特定行为的消息。参数message与Message构造函数具有相同的含义.

MH消息不支持传统意义上的标记或标记，但它们支持序列，它们是逻辑分组。任意消息。Somemail读取程序（虽然不是标准的 mh 和 nmh ）使用序列的方式与其他格式的标志大致相同，如如下：

序列	说明
看不见	不读，但以前被MUA检测到
回复	回复
标记	标记为重要

MHMessage实例提供以下方法：

get_sequences（）

返回包含此消息的序列名称列表.

set_sequences (sequences)

设置包含此消息的序列列表.

add_sequence（sequence）

将sequence添加到包含此消息的序列列表中

remove_sequence (sequence)

从包含此消息的序列列表中删除sequence.

当MHMessage实例是基于MaildirMessage实例创建的，发生了以下转换：

当基于一个MHMessage实例创建时mboxMessage或MMDFMessage实例，Status和X-Status标题被省略，以下转换位置：

当基于MHMessage实例创建BabylMessage实例时，会发生以下转换：

BabylMessage

class mailbox.BabylMessage（message=None）

带有Babyl特定的消息行为。参数message与Message构造函数具有相同的意义.

某些消息标签，称为attributes，按惯例定义具有特殊含义。属性如下：

标签	说明
看不见	未读，但以前被MUA检测到
删除	标记为后续删除
归档	复制到另一个文件或邮箱
回答	回复
转发	转发
编辑	由用户修改
resent	重新发送

默认情况下，Rmail只显示头。但是，BabylMessage类使用原始标题，因为它们更完整。如果需要，可以显式访问可见标题.

BabylMessage实例提供以下方法：

get_labels（）

返回消息上的标签列表。

set_labels（labels）

将邮件上的标签列表设置为labels.

add_label（label）

添加label到邮件上的标签列表.

remove_label(label)

从邮件上的标签列表中删除label.

get_visible ()

返回Message实例，其标题是消息的可见标题，其主体是空的.

set_visible(visible)

将消息的可见标题设置为与message中的标题相同。参数visible应该是Message实例，email.message.Message实例，字符串或文件类对象（应该以文本模式打开）.

update_visible（）

当BabylMessage实例的原始标题被修改，可见标题不会自动修改为对应。这样可以对可见标题进行如下操作：每个可见的标题与相应的原始标题被设置为原始标题的值，每个可见的标题都没有相应的原始标题被删除，以及任何Date, From, Reply-To,To, CC，和Subject原始标题中存在但不显示可见标题的内容会添加到可见标题中.

当一个 BabylMessage实例是基于MaildirMessage例如，发生以下转换：

当BabylMessage实例是基于mboxMessage或MMDFMessage实例创建的，Status和X-Status标题被省略，以下转换位置：

当BabylMessage实例基于MHMessage实例创建时，发生以下转换：

MMDFMessage

class mailbox.MMDFMessage（message=None）

包含MMDF特定行为的消息。参数message与Message构造函数

具有相同的含义。对于mbox邮箱中的消息，MMDF消息与这些地址和交付日期一起存储在初始行中以“From”开头。同样，指示消息状态的标志通常存储在Status和X-Status headers.

MMDF消息的常规标志与mbox消息的标志相同，如下：

标志	含义	说明
R	阅读	读
Ø	老	之前被MUA检测到
D	删除	标记为后续删除
F	标记	标记为重要
A	回答	回复

“R”和“O”标志存储在Status标题中，“D”，“F”和“A”标志存储在X-Status标题中。标志和标题通常按照提到的顺序出现.

MMDFMessage实例提供以下方法，这些方法与mboxMessage：

get_from（）

返回表示“From”行的字符串，该行标记mbox邮箱中邮件的开头。排除领先的“From”和尾随换行.

set_from (from_, time_=None)

将“From”行设置为from_，应该指定，而不指定“From”或尾随换行符。为方便起见，可以指定time_并将其格式化并附加到from_。如果指定了time_，它应该是time.struct_time实例，适合传递给time.strftime()或True的atup（使用time.gmtime()）.

get_flags（）

返回一个字符串，指定当前设置的标志。如果themessage符合传统格式，则结果是按 的每个零或一次出现的顺序进行连接"R", "O", "D", "F"和"A".

set_flags（flags）

设置flags指定的标志并取消所有其他标志。参数flags应该是"R", "O", "D", "F"和"A".

add_flag（flag）

设置flag指定的标志而不更改其他标志。要一次添加多个标志，flag可能是一个多个字符的字符串.

remove_flag(flag)

取消设置flag指定的标志而不更改其他标志。Toremove一次不止一个标志，flag也许是一串多个字符

当MMDFMessage实例是基于MaildirMessage实例创建的，根据MaildirMessage实例的交付日期生成“From”行，以及以下转换前置位置：

当MMDFMessage instance基于MHMessage实例创建，发生以下转换：

当基于MMDFMessage实例创建BabylMessage实例时，会发生以下转换：

当MMDFMessage instance是基于创建的在mboxMessage例如，复制“From”行并且所有标志直接对应：