18.5。 mhlib —MHメールボックスへのアクセス
mhlib モジュールは、MHフォルダーとその内容へのPythonインターフェースを提供します。
このモジュールには、特定のフォルダーのコレクションを表す MH 、単一のフォルダーを表す Folder 、および単一のフォルダーを表す Message の3つの基本クラスが含まれています。メッセージ。
- class mhlib.MH([path[, profile]])
- MH は、MHフォルダーのコレクションを表します。
- class mhlib.Folder(mh, name)
- Folder クラスは、単一のフォルダーとそのメッセージを表します。
- class mhlib.Message(folder, number[, name])
- メッセージオブジェクトは、フォルダー内の個々のメッセージを表します。 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)
- 1つのメッセージを別のフォルダの特定の宛先に移動します。
- Folder.copymessage(n, tofolder, ton)
- 1つのメッセージを別のフォルダの特定の宛先にコピーします。
18.5.3。 メッセージオブジェクト
Message クラスは、 mimetools.Message のメソッドに1つのメソッドを追加します。
- Message.openmessage(n)
- 新しい開いているメッセージオブジェクトを返します(ファイル記述子のコストがかかります)。