11.6.1 IMAP4 オブジェクト

すべてのIMAP4コマンドは大文字小文字どちらかの 同じ名前のメソッドで表されます。

それぞれのコマンドはタプルを返します: (type, [data, ...]) ここで、typeは通常'OK'か'NO'、 またdataはコマンドの応答の文字列か、コマンドの実行結果です。

IMAP4インスタンスは次のメソッドを持っています:

append (mailbox, flags, date_time, message)

メールボックス"mailbox"に、メッセージを追加します。

authenticate (func)

認証コマンド -- 応答の処理が必要です。 これは実装されておらず、例外を発生します。

check ()

サーバ上のメールボックスのチェックをします。

close ()

現在選択されているメールボックスを閉じます。 書き込み可能なメールボックスからは削除されたメッセージを消去します。 これは"LOGOUT"の前に実行することが推奨されます。

copy (message_set, new_mailbox)

message_setメッセージを new_mailboxの最後にコピーします。

create (mailbox)

mailboxという名前の新しいメールボックスを作成します。

delete (mailbox)

mailboxという名前のメールボックスを削除します。

expunge ()

選択されたメールボックスの削除されたアイテムを消去します。 削除されたメッセージごとに"EXPUNGE"応答を発生します。 返ってくる値には"EXPUNGE"のリストが受け取った順に含まれます。

fetch (message_set, message_parts)

メッセージ(の一部)を取り込みます。 これはメッセージのエンベロープとデータのタプルを返します。

list ([directory[, pattern]])

patternに一致するdirectoryの中のメールボックスをリストします。 directorはデフォルトではメールフォルダのトップディレクトリで、 patternはすべてに一致します。 戻ってくるデータには、"LIST"の応答のリストを含みます。

login (user, password)

プレーンテキスト パスワードを使用してユーザを認証します。

logout ()

接続を閉じます。 サーバの、コマンド"BYE"に対する応答を返します。

lsub ([directory[, pattern]])

direcotryの中のpatternにマッチングするメールボックスの名前をリストします。 directoryはデフォルトではトップディレクトリで、 patternはすべてのメールボックスにマッチします。 返すデータはメッセージのエンベロープとデータのタプルです。

recent ()

更新をサーバに通知します。 返すデータは、新しいメッセージがなければNone、 あれば"RECENT"の応答となります。

rename (oldmailbox, newmailbox)

oldmailboxの名前をnewmailboxに変更します。

response (code)

response codeに対するデータを返します。 なければNoneを返します。 与えられたコードを通常のタイプの代わりに返します。

search (charset, criteria)

マッチするメッセージを検索します。 これはマッチしたメッセージの番号をスペースで区切って返します。

select ([mailbox[, readonly]])

メールボックスを選択します。 mailbox("EXISTS"応答の場合)にあるメッセージの数を返します。 デフォルトではmailboxは'INBOX'です。 readonlyフラグがセットされていると、メールボックスは変更できません。

status (mailbox, names)

mailboxに対するステータスを要求します。

store (message_set, command, flag_list)

mailbox中のメッセージに対するフラグを変更します。

subscribe (mailbox)

新しいメールボックスを読みます。

uid (command, args)

メッセージ番号ではなく、UIDによって指定されるメッセージを引数として コマンド(command)を実行します。 コマンドの実行結果を返します。

unsubscribe (mailbox)

古いメールボックス(mailbox)を読まないようにします。

xatom (name[, arg1[, arg2]])

サーバから"CAPABILITY"の応答により通知された シンプルな拡張コマンドを許可します。

次の属性がIMAP4のインスタンスで定義されています。

PROTOCOL_VERSION

"CAPABILITY"のサーバからの応答で、 サポートされている最新のプロトコル。

debug

デバッグ出力をコントロールする整数値。 初期値はDebugモジュールの変数から取られます。 ３以上ではすべてのコマンドをトレースします。