このモジュールは、IMAP4クラスを定義しており、
RFC 2060で定義される
IMAP4サーバとIMAP4 rev1クライアントプロトコルの実装をカプセル化します。
これはIMAP4 (RFC 1730)サーバと互換性がありますが、
"STATUS"コマンドはサポートされていないことに注意してください。
imaplibモジュールでは単一のクラスが定義されます:
- IMAP4 ([host[, port]])
-
このクラスは、実際のIMAP4プロトコルを実装します。
接続およびプロトコルのバージョン(IMAP4かIMAP4 rev1か)の決定は、
インスタンスが初期化されるときに行われます。
hostが指定されないとき、''(localhost)が使われます。
portが省略されると、標準のIMAP4ポート(143)が使用されます。
IMAP4クラスでは二つの例外が属性として定義されています。
- IMAP4.error
-
どんなエラーでも例外が発生します。
例外の原因は文字列のコンストラクタに渡されます。
- IMAP4.abort
-
IMAP4サーバエラーはこの例外を発生します。
これはIMAP4.errorのサブクラスです。
インスタンスのクローズと新しいインスタンスの生成は通常、
この例外からの回復を許すことに注意してください。
次のユーティリティ関数が定義されています。
- Internaldate2tuple (datestr)
-
IMAP4内部日付文字列をUTCに変換します。
timeモジュールのタプルを返します。
- Int2AP (num)
-
整数を[A .. P]からなる文字を使った文字列表現に変換します。
- ParseFlags (flagstr)
-
IMAP4"FLAGS"応答をばらばらなフラグにします。
- Time2Internaldate (date_time)
-
timeモジュールタプルをIMAP4の内部日付表現に変換します。
これは次の形式の文字列を返します:"DD-Mmm-YYYY HH:MM:SS +HHMM"
(ダブルクォートを含みます)
guido@python.org