On this page
18.5. mhlib-访问 MH 邮箱
自 2.6 版起已弃用:mhlib模块已在 Python 3 中删除。请改用mailbox。
mhlib模块为 MH 文件夹及其内容提供 Python 接口。
该模块包含三个基本类,MH代表文件夹的特定集合,Folder代表单个文件夹,Message代表单个消息。
-
- class *
mhlib.
MH
([* path * [,* profile *]])
- MH代表 MH 文件夹的集合。
- class *
-
- class *
mhlib.
Folder
(* mh , name *)
- Folder类代表单个文件夹及其消息。
- class *
-
- class *
mhlib.
Message
(* folder , number * [,* name *])
- Message对象代表文件夹中的单个邮件。 Message 类是从mimetools.Message派生的。
- class *
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 *)- 返回文件夹名称:list 中序列的字典。
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 *)- 返回一个新的打开消息对象(花费一个文件 Descriptors)。