18.5. mhlib — 访问 MH 邮箱 — Python 文档

来自菜鸟教程
Python/docs/2.7/library/mhlib
跳转至:导航、​搜索

18.5. mhlib — 访问 MH 邮箱

自 2.6 版起已弃用:mhlib 模块已在 Python 3 中删除。 请改用 邮箱


mhlib 模块为 MH 文件夹及其内容提供了 Python 接口。

该模块包含三个基本类,MH,表示特定的文件夹集合,Folder,表示单个文件夹,以及 Message,表示单个文件夹信息。

class mhlib.MH([path[, profile]])
MH 表示 MH 文件夹的集合。
class mhlib.Folder(mh, name)
Folder 类表示单个文件夹及其消息。
class mhlib.Message(folder, number[, name])
Message 对象代表文件夹中的单个消息。 Message 类派生自 mimetools.Message

18.5.1. MH 对象

MH实例有以下方法:

MH.error(format[, ...])
打印错误消息 - 可以被覆盖。
MH.getprofile(key)
返回配置文件条目(None 如果未设置)。
MH.getpath()
返回邮箱路径名。
MH.getcontext()
返回当前文件夹名称。
MH.setcontext(name)
设置当前文件夹名称。
MH.listfolders()
返回顶级文件夹列表。
MH.listallfolders()
返回所有文件夹的列表。
MH.listsubfolders(name)
返回给定文件夹的直接子文件夹列表。
MH.listallsubfolders(name)
返回给定文件夹的所有子文件夹的列表。
MH.makefolder(name)
新建一个文件夹。
MH.deletefolder(name)
删除文件夹 – 不得有子文件夹。
MH.openfolder(name)
返回一个新的打开文件夹对象。


18.5.2. 文件夹对象

Folder 实例代表打开的文件夹,有以下方法:

Folder.error(format[, ...])
打印错误消息 - 可以被覆盖。
Folder.getfullname()
返回文件夹的完整路径名。
Folder.getsequencesfilename()
返回文件夹序列文件的完整路径名。
Folder.getmessagefilename(n)
返回文件夹的消息 n 的完整路径名。
Folder.listmessages()
返回文件夹中的消息列表(以数字形式)。
Folder.getcurrent()
返回当前消息号。
Folder.setcurrent(n)
将当前消息编号设置为 n
Folder.parsesequence(seq)
将 msgs 语法解析为消息列表。
Folder.getlast()
获取最后一条消息,如果文件夹中没有消息,则获取 0
Folder.setlast(n)
设置最后一条消息(仅供内部使用)。
Folder.getsequences()
返回文件夹中序列的字典。 序列名称用作键,值是序列中消息编号的列表。
Folder.putsequences(dict)
返回文件夹名称中的序列字典:列表。
Folder.removemessages(list)
从文件夹中删除列表中的邮件。
Folder.refilemessages(list, tofolder)
将列表中的邮件移动到其他文件夹。
Folder.movemessage(n, tofolder, ton)
将一封邮件移动到另一个文件夹中的给定目的地。
Folder.copymessage(n, tofolder, ton)
将一封邮件复制到另一个文件夹中的给定目的地。


18.5.3. 消息对象

Message 类为 mimetools.Message 添加了一个方法:

Message.openmessage(n)
返回一个新的打开消息对象(需要一个文件描述符)。