12.4 `mailbox` -- 様々なメールボックス形式の読み出し

このモジュールでは (Unixの) メイルボックス内のメイルに簡単かつ一様な方法でアクセスできるようにするクラスを定義しています。

クラス UnixMailbox( fp[, factory])

全てのメッセージが単一のファイルに収められ、"From " ("From_" として知られています) 行によって分割されているような、旧来の Unix形式のメイルボックスにアクセスします。ファイルオブジェクト fp はメイルボックスファイルを指します。オプションの factory パラメタは新たなメッセージオブジェクトを生成するような呼び出し可能オブジェクトです。factory は、メイルボックスオブジェクトに対して next() メソッドを実行した際に、単一の引数、fp を伴って呼び出されます。この引数の標準の値は rfc822.Message クラスです (rfc822 モジュール - および以下 - を参照してください)。

注意: このモジュールの実装上の理由により、fp オブジェクトはバイナリモードで開くようにしてください。特にWindows上では注意が必要です。

可搬性を最大限にするために、Unix形式のメイルボックス内にあるメッセージは、正確に 'From ' (末尾の空白に注意してください) で始まる文字列が、直前の正しく二つの改行の後にくるような行で分割されます。現実的には広範なバリエーションがあるため、それ以外の From_ 行について考慮すべきではないのですが、現在の実装では先頭の二つの改行をチェックしていません。これはほとんどのアプリケーションでうまく動作します。

UnixMailbox クラスでは、ほぼ正確に From_ デリミタにマッチするような正規表現を用いることで、より厳密に From_ 行のチェックを行うバージョンを実装しています。UnixMailbox ではデリミタ行が "From name time" の行に分割されるものと考えます。可搬性を最大限にするためには、代わりに PortableUnixMailbox クラスを使ってください。このクラスは UnixMailbox と同じですが、個々のメッセージは "From " 行だけで分割されるものとみなします。

より詳細な情報については、 Configuring Netscape Mail on Unix: Why the Content-Length Format is Bad を参照してください。

クラス PortableUnixMailbox( fp[, factory]): 厳密性の低い UnixMailbox のバージョンで、メッセージを分割する行は "From " のみであると見なします。実際に見られるメイルボックスのバリエーションに対応するため、 From 行における ``name time'' 部分は無視されます。メイル処理ソフトウェアはメッセージ中の 'From ' で始まる行をクオートするため、この分割はうまく動作します。

クラス MmdfMailbox( fp[, factory]): 全てのメッセージが単一のファイルに収められ、4 つの control-A 文字によって分割されているような、MMDF 形式のメイルボックスにアクセスします。ファイルオブジェクト fp はメイルボックスファイルをさします。オプションの factory は UnixMailbox クラスにおけるのと同様です。

クラス MHMailbox( dirname[, factory]): 数字で名前のつけられた別々のファイルに個々のメッセージを収めたディレクトリである、MH メイルボックスにアクセスします。メイルボックスディレクトリの名前は dirname で渡します。 factory は UnixMailbox クラスにおけるのと同様です。

クラス Maildir( dirname[, factory]): Qmail メイルディレクトリにアクセスします。dirname で指定された全ての新規および現在のメッセージにアクセスできます。 factory は UnixMailbox クラスにおけるのと同様です。

クラス BabylMailbox( fp[, factory]): MMDF メイルボックスと似ている、Babyl メイルボックスにアクセスします。 Babyl 形式では、各メッセージは二つのヘッダからなるセット、 original ヘッダおよび visible ヘッダをを持っています。 original ヘッダは '*** EOOH ***' (End-Of-Original-Headers) だけを含む行の前にあり、visible ヘッダは EOOH 行の後にあります。Babyl 互換のメイルリーダは visible ヘッダのみを表示し、 BabylMailbox オブジェクトは visible ヘッダのみを含むようなメッセージを返します。メイルメッセージは EOOH 行で始まり、 '\037\014' だけを含む行で終わります。 factory は UnixMailbox クラスにおけるのと同様です。

rfc822 モジュールが撤廃されたことにより、 email パッケージを使ってメイルボックスからメッセージオブジェクトを生成するよう推奨されているので注意してください。 (デフォルトの設定は以前のバージョンとの互換性のために変更されていません。) 安全に移行を行うには、以下のちょっとしたコードを使います:

import email
import email.Errors
import mailbox

def msgfactory(fp):
    try:
        return email.message_from_file(fp)
    except email.Errors.MessageParseError:
        # Don't return None since that will
	# stop the mailbox iterator
	return ''

mbox = mailbox.UnixMailbox(fp, msgfactory)

上のラッパはメイルボックス内にある不正な形式の MIME メッセージに対して防御性がある反面、メイルボックスの next() メソッドが空文字列を渡す場合に備えなければなりません。逆に、もしメイルボックス内には正しい形式の MIME メッセージしか入っていないと分かっているのなら、単に以下のようにします:

import email
import mailbox

mbox = mailbox.UnixMailbox(fp, email.message_from_file)

参考:

mbox - file containing mail messages: 伝統的な ``mbox'' メイルボックス形式に関する記述です。

maildir - directory for incoming mail messages: ``maildir'' メイルボックス形式の記述です。

Configuring Netscape Mail on Unix: Why the Content-Length Format is Bad: メイルボックスファイルに記録されている Content-Length: ヘッダに依存した場合に発生する問題についての記述です。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。

12.4 mailbox -- 様々なメールボックス形式の読み出し

12.4 `mailbox` -- 様々なメールボックス形式の読み出し