これは既にサポートされていない古いバージョンの Python のドキュメントです。 是非 Python をアップグレードし、このドキュメントを読みましょう: 現在の安定板リリースの Python ドキュメント.

# `email.parser`: 電子メールメッセージのパース

ソースコード: Lib/email/parser.py

Message object structures can be created in one of two ways: they can be created from whole cloth by creating an `EmailMessage` object, adding headers using the dictionary interface, and adding payload(s) using `set_content()` and related methods, or they can be created by parsing a serialized representation of the email message.

The `email` package provides a standard parser that understands most email document structures, including MIME documents. You can pass the parser a bytes, string or file object, and the parser will return to you the root `EmailMessage` instance of the object structure. For simple, non-MIME messages the payload of this root object will likely be a string containing the text of the message. For MIME messages, the root object will return `True` from its `is_multipart()` method, and the subparts can be accessed via the payload manipulation methods, such as `get_body()`, `iter_parts()`, and `walk()`.

There are actually two parser interfaces available for use, the `Parser` API and the incremental `FeedParser` API. The `Parser` API is most useful if you have the entire text of the message in memory, or if the entire message lives in a file on the file system. `FeedParser` is more appropriate when you are reading the message from a stream which might block waiting for more input (such as reading an email message from a socket). The `FeedParser` can consume and parse the message incrementally, and only returns the root object when you close the parser.

Note that the parser can be extended in limited ways, and of course you can implement your own parser completely from scratch. All of the logic that connects the `email` package's bundled parser and the `EmailMessage` class is embodied in the `policy` class, so a custom parser can create message object trees any way it finds necessary by implementing custom versions of the appropriate `policy` methods.

## FeedParser API

The `BytesFeedParser`, imported from the `email.feedparser` module, provides an API that is conducive to incremental parsing of email messages, such as would be necessary when reading the text of an email message from a source that can block (such as a socket). The `BytesFeedParser` can of course be used to parse an email message fully contained in a bytes-like object, string, or file, but the `BytesParser` API may be more convenient for such use cases. The semantics and results of the two parser APIs are identical.

`BytesFeedParser` API は簡単です。まずインスタンスをつくり、それに bytes を (それ以上 bytes が必要なくなるまで) 流しこみます。その後パーザを close すると根っこ (root) のメッセージオブジェクトが返されます。標準に従ったメッセージを解析する場合、 `BytesFeedParser` は非常に正確であり、標準に従っていないメッセージでもちゃんと動きます。そのさい、これはメッセージがどのように壊れていると認識されたかについての情報を残します。これはメッセージオブジェクトの `defects` 属性にリストとして現れ、メッセージ中に発見された問題が記録されます。パーザが検出できる障害 (defect) については `email.errors` モジュールを参照してください。

以下は `BytesFeedParser` の API です:

class `email.parser.``BytesFeedParser`(_factory=None, *, policy=policy.compat32)

  Create a `BytesFeedParser` instance. Optional _factory is a no-argument callable; if not specified use the `message_factory` from the policy. Call _factory whenever a new message object is needed.

  If policy is specified use the rules it specifies to update the representation of the message. If policy is not set, use the `compat32` policy, which maintains backward compatibility with the Python 3.2 version of the email package and provides `Message` as the default factory. All other policies provide `EmailMessage` as the default _factory. For more information on what else policy controls, see the `policy` documentation.

  Note: The policy keyword should always be specified; The default will change to `email.policy.default` in a future version of Python.

  バージョン 3.2 で追加.

  バージョン 3.3 で変更: キーワード引数 policy が追加されました。

  バージョン 3.6 で変更: _factory defaults to the policy `message_factory`.

  `feed`(data)

    パーサーにデータを供給します。 data は 1行または複数行からなる bytes-like object を渡します。渡される行は完結していなくてもよく、その場合パーサーは部分的な行を適切につなぎ合わせます。各行は3種類の標準的な行末文字 (復帰 CR、改行 LF、または CR+LF) どれかの組み合わせでよく、これらが混在してもかまいません。

  `close`()

    Complete the parsing of all previously fed data and return the root message object. It is undefined what happens if `feed()` is called after this method has been called.

class `email.parser.``FeedParser`(_factory=None, *, policy=policy.compat32)

  Works like `BytesFeedParser` except that the input to the `feed()` method must be a string. This is of limited utility, since the only way for such a message to be valid is for it to contain only ASCII text or, if `utf8` is `True`, no binary attachments.

  バージョン 3.3 で変更: キーワード引数 policy が追加されました。

## Parser API

The `BytesParser` class, imported from the `email.parser` module, provides an API that can be used to parse a message when the complete contents of the message are available in a bytes-like object or file. The `email.parser` module also provides `Parser` for parsing strings, and header-only parsers, `BytesHeaderParser` and `HeaderParser`, which can be used if you're only interested in the headers of the message. `BytesHeaderParser` and `HeaderParser` can be much faster in these situations, since they do not attempt to parse the message body, instead setting the payload to the raw body.

class `email.parser.``BytesParser`(_class=None, *, policy=policy.compat32)

  Create a `BytesParser` instance. The _class and policy arguments have the same meaning and semantics as the _factory and policy arguments of `BytesFeedParser`.

  Note: The policy keyword should always be specified; The default will change to `email.policy.default` in a future version of Python.

  バージョン 3.3 で変更: 2.4 で非推奨になった strict 引数の削除。キーワード引数 policy の追加。

  バージョン 3.6 で変更: _class defaults to the policy `message_factory`.

  `parse`(fp, headersonly=False)

    Read all the data from the binary file-like object fp, parse the resulting bytes, and return the message object. fp must support both the `readline()` and the `read()` methods.

    The bytes contained in fp must be formatted as a block of RFC 5322 (or, if `utf8` is `True`, RFC 6532) style headers and header continuation lines, optionally preceded by an envelope header. The header block is terminated either by the end of the data or by a blank line. Following the header block is the body of the message (which may contain MIME-encoded subparts, including subparts with a Content-Transfer-Encoding of `8bit`).

    オプション引数 headersonly はヘッダを読み終えた後にパースを止めるかを指定するフラグです。デフォルトは `False` で、ファイルの内容全体をパースします。

  `parsebytes`(bytes, headersonly=False)

    Similar to the `parse()` method, except it takes a bytes-like object instead of a file-like object. Calling this method on a bytes-like object is equivalent to wrapping bytes in a `BytesIO` instance first and calling `parse()`.

    オプション引数 headersonly は `parse()` メソッドと同じです。

  バージョン 3.2 で追加.

class `email.parser.``BytesHeaderParser`(_class=None, *, policy=policy.compat32)

  Exactly like `BytesParser`, except that headersonly defaults to `True`.

  バージョン 3.3 で追加.

class `email.parser.``Parser`(_class=None, *, policy=policy.compat32)

  This class is parallel to `BytesParser`, but handles string input.

  バージョン 3.3 で変更: strict 引数の削除。キーワード引数 policy の追加。

  バージョン 3.6 で変更: _class defaults to the policy `message_factory`.

  `parse`(fp, headersonly=False)

    ファイルなどテキストモードのストリーム形式 (file-like) のオブジェクト fp からすべてのデータを読み込み、得られたテキストを解析して基底 (root) メッセージオブジェクト構造を返します。 fp はストリーム形式のオブジェクトで `readline()` および `read()` 両方のメソッドをサポートしている必要があります。

    Other than the text mode requirement, this method operates like `BytesParser.parse()`.

  `parsestr`(text, headersonly=False)

    `parse()` メソッドに似ていますが、ファイルなどのストリーム形式のかわりに文字列を引数としてとるところが違います。文字列に対してこのメソッドを呼ぶことは、 text を `StringIO` インスタンスとして作成して `parse()` を適用するのと同じです。

    オプション引数 headersonly は `parse()` メソッドと同じです。

class `email.parser.``HeaderParser`(_class=None, *, policy=policy.compat32)

  Exactly like `Parser`, except that headersonly defaults to `True`.

ファイルや文字列からメッセージオブジェクト構造を作成するのはかなりよくおこなわれる作業なので、便宜上次のような 4つの関数が提供されています。これらは `email` パッケージのトップレベルの名前空間で使用できます。

`email.``message_from_bytes`(s, _class=None, *, policy=policy.compat32)

  bytes-like オブジェクト からメッセージオブジェクト構造を作成して返します。これは `BytesParser().parsebytes(s)` と同じです。オプション引数 _class および policy は `BytesParser` クラスのコンストラクタと同様に解釈されます。

  バージョン 3.2 で追加.

  バージョン 3.3 で変更: strict 引数の削除。キーワード引数 policy の追加。

`email.``message_from_binary_file`(fp, _class=None, *, policy=policy.compat32)

  オープンされたバイナリ file object からメッセージオブジェクト構造を作成して返します。これは `BytesParser().parse(fp)` と同じです。 _class および policy は `BytesParser` クラスのコンストラクタと同様に解釈されます。

  バージョン 3.2 で追加.

  バージョン 3.3 で変更: strict 引数の削除。キーワード引数 policy の追加。

`email.``message_from_string`(s, _class=None, *, policy=policy.compat32)

  文字列からメッセージオブジェクト構造を作成して返します。これは `Parser().parsestr(s)` と同じです。 _class および policy は `Parser` クラスのコンストラクタと同様に解釈されます。

  バージョン 3.3 で変更: strict 引数の削除。キーワード引数 policy の追加。

`email.``message_from_file`(fp, _class=None, *, policy=policy.compat32)

  オープンされた file object からメッセージオブジェクト構造を作成して返します。これは `Parser().parse(fp)` と同じです。 _class および policy は `Parser` クラスのコンストラクタと同様に解釈されます。

  バージョン 3.3 で変更: strict 引数の削除。キーワード引数 policy の追加。

  バージョン 3.6 で変更: _class defaults to the policy `message_factory`.

対話的な Python プロンプトで `message_from_bytes()` を使用するとすれば、このようになります:

    >>> import email
    >>> msg = email.message_from_bytes(myBytes)

## 追記事項

以下はテキスト解析の際に適用されるいくつかの規約です:

- Most non-multipart type messages are parsed as a single message object with a string payload. These objects will return `False` for `is_multipart()`, and `iter_parts()` will yield an empty list.

- All multipart type messages will be parsed as a container message object with a list of sub-message objects for their payload. The outer container message will return `True` for `is_multipart()`, and `iter_parts()` will yield a list of subparts.

- Most messages with a content type of message/* (such as message/delivery-status and message/rfc822) will also be parsed as container object containing a list payload of length 1. Their `is_multipart()` method will return `True`. The single element yielded by `iter_parts()` will be a sub-message object.

- いくつかの標準的でないメッセージは、 multipart の使い方に統一がとれていない場合があります。このようなメッセージは Content-Type ヘッダに multipart を指定しているものの、その `is_multipart()` メソッドは `False` を返すことがあります。もしこのようなメッセージが `FeedParser` によって解析されると、その defects 属性のリスト中には `MultipartInvariantViolationDefect` クラスのインスタンスが現れます。詳しい情報については `email.errors` を参照してください。