Python ライブラリリファレンス

Previous: 7.3.2.1 MaildirMessage Up: 7.3.2 Message objects Next: 7.3.2.3 MHMessage

---

7.3.2.2 mboxMessage

クラス mboxMessage(

[message])

mbox 固有の動作をするメッセージ。引数 message は Message のコンストラクタと同じ意味を持ちます。

mbox メールボックス中のメッセージは単一ファイルにまとめて格納されています。 送り主のエンベロープアドレスおよび配送日時は通常メッセージの開始を示す "From " から 始まる行に記録されますが、正確なフォーマットに関しては mbox の実装ごとに 大きな違いがあります。メッセージの状態を示すフラグ、たとえば読んだかどうかあるいは 重要だとマークを付けられているかどうかといったようなもの、は典型的には Status: および X-Status: に収められます。

規定されている mbox メッセージのフラグは以下の通りです:

"R" および "O" フラグは Status: ヘッダに記録され、 "D"、"F"、"A" フラグは X-Status: ヘッダに記録されます。 フラグとヘッダは通常記述された順番に出現します。

mboxMessage インスタンスは以下のメソッドを提供します:

get_from(

)

mbox メールボックスのメッセージの開始を示す "From " 行を表わす文字列を返します。 先頭の "From " および末尾の改行は含まれません。

set_from(

from_[, time_=None])

"From " 行を from_ にセットします。from_ は先頭の "From " や 末尾の改行を含まない形で指定しなければなりません。利便性のために、time_ を指定して適切に整形して from_ に追加させることができます。time_ を指定する場合、それは struct_time インスタンス、time.strftime() に渡すのに適したタプル、または True (この場合 time.gmtime() を使います)のいずれかでなければなりません。

get_flags(

)

現在セットされているフラグを特定する文字列を返します。メッセージが規定された形式に 準拠しているならば、結果は次の順に並べられたゼロまたは1回の "R"、 "O"、"D"、"F"、"A" です。

set_flags(

flags)

flags で指定されたフラグをセットして、他のフラグは下ろします。 flags は並べられたゼロまたは1回の "R"、 "O"、"D"、"F"、"A" です。

add_flag(

flag)

flags で指定されたフラグをセットしますが他のフラグは変えません。 一度に二つ以上のフラグをセットすることは、flag に2文字以上の文字列を 指定すればできます。

remove_flag(

flag)

flags で指定されたフラグを下ろしますが他のフラグは変えません。 一度に二つ以上のフラグを取り除くことは、flag に2文字以上の文字列を 指定すればできます。

mboxMessage インスタンスが MaildirMessage インスタンスに 基づいて生成されるとき、MaildirMessage インスタンスの配送日時に基づいて "From " 行が作り出され、次の変換が行われます:

mboxMessage インスタンスが MHMessage インスタンスに 基づいて生成されるとき、以下の変換が行われます。

mboxMessage インスタンスが BabylMessage インスタンスに 基づいて生成されるとき、以下の変換が行われます:

mboxMessage インスタンスが MMDFMessage インスタンスに 基づいて生成されるとき、"From " 行はコピーされ全てのフラグは直接対応します:

---

Python ライブラリリファレンス

Previous: 7.3.2.1 MaildirMessage Up: 7.3.2 Message objects Next: 7.3.2.3 MHMessage

---

リリース 2.5 ，19th September, 2006 更新