Python标准库mailbox操作多种格式的邮箱

MaildirMessage¶

class mailbox.MaildirMessage(message=None)¶

具有 Maildir 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

通常，邮件用户代理应用程序会在用户第一次打开并关闭邮箱之后将 new 子目录中的所有消息移至 cur 子目录，将这些消息记录为旧消息，无论它们是否真的已被阅读。 cur 下的每条消息都有一个 "info" 部分被添加到其文件名中以存储有关其状态的信息。 （某些邮件阅读器还会把 "info" 部分也添加到 new 下的消息中。） "info" 部分可以采用两种形式之一：它可能包含 "2," 后面跟一个经标准化的旗标列表（例如 "2,FR"）或者它可能包含 "1," 后面跟所谓的实验性信息。 Maildir 消息的标准旗标如下:

标志	含义	解释
D	草稿	正在撰写中
F	已标记	标记为重要
P	已读	转发，重新发送或退回
R	已回复	回复给
S	查看	读取
T	已删除	标记为以后删除

MaildirMessage 实例提供以下方法：

get_subdir()¶

返回 "new" (如果消息应当被存储在 new 子目录下) 或者 "cur" (如果消息应当被存储在 cur 子目录下)。

注解

消息通常会在其邮箱被访问后被从 new 移至 cur，无论该消息是否已被阅读。 如果 msg.get_flags()`` 中的 "S"为``True 则说明消息 msg 已被阅读。

set_subdir(subdir)¶

设置消息应当被存储到的子目录。 形参 subdir 必须为 "new" 或 "cur"。

get_flags()¶

返回一个指明当前所设旗标的字符串。 如果消息符合标准的 Maildir 格式，则结果为零或按字母顺序各自出现一次的 'D', 'F', 'P', 'R', 'S' 和 'T' 的拼接。 如果未设任何旗标或者如果 "info" 包含实验性语义则返回空字符串。

set_flags(flags)¶

设置由 flags 所指定的旗标并重置所有其它旗标。

add_flag(flag)¶

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。 当前 "info" 会被覆盖，无论它是否只包含实验性信息而非旗标。

remove_flag(flag)¶

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。 如果 "info" 包含实验性信息而非旗标，则当前的 "info" 不会被修改。

get_date()¶

以表示 Unix 纪元秒数的浮点数形式返回消息的发送日期。

set_date(date)¶

将消息的发送日期设为 date，一个表示 Unix 纪元秒数的浮点数。

get_info()¶

返回一个包含消息的 "info" 的字符串。 这适用于访问和修改实验性的 "info" (即不是由旗标组成的列表)。

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 邮箱中的消息会一起存储在单个文件中。 发件人的信封地址和发送时间通常存储在指明每条消息的起始的以 "From " 打头的行中，不过在 mbox 的各种实现之间此数据的确切格式具有相当大的差异。 指明消息状态的各种旗标，例如是否已读或标记为重要等等通常存储在 Status 和 X-Status 标头中。

传统的 mbox 消息旗标如下:

标志	含义	解释
R	读取	读取
O	旧的	以前由MUA检测
D	已删除	标记为以后删除
F	已标记	标记为重要
A	已回复	回复给

"R" 和 "O" 旗标存储在 Status 标头中，而 "D", "F" 和 "A" 旗标存储在 X-Status 标头中。 旗标和标头通常会按上述顺序显示。

mboxMessage 实例提供了下列方法:

get_from()¶

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。

set_from(from_, time_=None)¶

将 "From " 行设为 from_，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 time_ 并将经过适当的格式化再添加到 from_。 如果指定了 time_，它应当是一个 time.struct_time 实例，适合传入 time.strftime() 的元组或者 True (以使用 time.gmtime())。

get_flags()¶

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 'R', 'O', 'D', 'F' 和 'A' 按上述顺序的拼接。

set_flags(flags)¶

设置由 flags 所指明的旗标并重启所有其他旗标。 形参 flags 应当为零或各自出现多次的 'R', 'O', 'D', 'F' 和 'A' 按任意顺序的拼接。

add_flag(flag)¶

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。

remove_flag(flag)¶

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。

当一个 mboxMessage 实例基于 MaildirMessage 实例被创建时，"From " 行会基于 MaildirMessage 实例的发送时间被生成，并进行下列转换:

当一个 mboxMessage 实例基于 MHMessage 实例被创建时，将进行下列转换:

当一个 mboxMessage 实例基于 BabylMessage 实例被创建时，将进行下列转换:

当一个 Message 实例基于 MMDFMessage 实例被创建时，"From " 行会被拷贝并直接对应所有旗标。

MHMessage¶

class mailbox.MHMessage(message=None)¶

具有 MH 专属行为的消息。 形参 message 的含义与 Message 构造器一致。

MH 消息不支持传统意义上的标记或旗标，但它们支持序列，即对任意消息的逻辑分组。 某些邮件阅读程序 (但不包括标准 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 构造器一致。

某些消息标签被称为 属性，根据惯例被定义为具有特殊的含义。 这些属性如下所示:

标签	解释
未读	未读取，但先前被MUA检测到
deleted	标记为以后删除
filed	复制到另一个文件或邮箱
answered	回复给
forwarded	已转发
edited	由用户修改
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 标头中。

传统的 MMDF 消息旗标与 mbox 消息的类似，如下所示:

标志	含义	解释
R	读取	读取
O	旧的	以前由MUA检测
D	已删除	标记为以后删除
F	已标记	标记为重要
A	已回复	回复给

"R" 和 "O" 旗标存储在 Status 标头中，而 "D", "F" 和 "A" 旗标存储在 X-Status 标头中。 旗标和标头通常会按上述顺序显示。

MMDFMessage 实例提供了下列方法，与 mboxMessage 所提供的类似:

get_from()¶

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。

set_from(from_, time_=None)¶

将 "From " 行设为 from_，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 time_ 并将经过适当的格式化再添加到 from_。 如果指定了 time_，它应当是一个 time.struct_time 实例，适合传入 time.strftime() 的元组或者 True (以使用 time.gmtime())。

get_flags()¶

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 'R', 'O', 'D', 'F' 和 'A' 按上述顺序的拼接。

set_flags(flags)¶

设置由 flags 所指明的旗标并重启所有其他旗标。 形参 flags 应当为零或各自出现多次的 'R', 'O', 'D', 'F' 和 'A' 按任意顺序的拼接。

add_flag(flag)¶

设置由 flag 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，flag 可以为包含一个以上字符的字符串。

remove_flag(flag)¶

重置由 flag 所指明的旗标而不改变其他旗标。 要一次性移除一个以上的旗标，flag 可以为包含一个以上字符的字符串。

当一个 MMDFMessage 实例基于 MaildirMessage 实例被创建时，"From " 行会基于 MaildirMessage 实例的发送日期被生成，并进入下列转换:

当一个 MMDFMessage 实例基于 MHMessage 实例被创建时，将进入下列转换:

当一个 MMDFMessage 实例基于 BabylMessage 实例被创建时，将进行下列转换:

当一个 MMDFMessage 实例基于 mboxMessage 实例被创建时，"From " 行会被拷贝并直接对应所有旗标: