object imap_fetchstructure(int imap_stream, int msg_number, int
[flags]
);この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。 オプションのパラメータ flags に指定可能なのは FT_UIDのみで、これは、 引数 msg_number をUID として 処理することを関数に指定するためのものです。 返されるオブジェクトは、MIMEの添付の各要素に類似のオブジェクトとして エンベロープ、内部の日付、サイズ、フラグ、本体を含んでいます。 返されるオブジェクトの構造は次のようになります。
表 1. imap_fetchstructure()で返されるオブジェクト
| type | 最初のbody部の型 |
| encoding | body部を転送する際のエンコード法 |
| ifsubtype | subtype文字列がある場合にtrue |
| subtype | MIME の subtype |
| ifdescription | description文字列がある場合にtrue |
| description | 内容を記述する文字列 |
| ifid | identification 文字列がある場合にtrue |
| id | identification 文字列 |
| lines | 行数 |
| bytes | バイト数 |
| ifdisposition | disposition 文字列がある場合にtrue |
| disposition | disposition 文字列 |
| ifdparameters | dparameters 配列が存在する場合に true |
| dparameters [a] | 特性パラメータ配列 |
| ifparameters | 配列parametersが存在する場合にtrue |
| parameters [b] | MIME パラメータ配列 |
| parts [c] | 各メッセージパートを記述するオブジェクトの配列 |
| 注意: a dparameters はオブジェクトの配列です。 各オブジェクトは、プロパティ "attribute" および "value" を有しています。 b parameter はオブジェクトの配列です。各オブジェクトは、 プロパティ "attributte" および "value" を有しています。 c parts はオブジェクトの配列であり、最上位のオブジェクト と構造が同じです。ただし、'parts' オブジェクトを含むことが できないという制限があります。 | |
表 2. Primary body type
| 0 | text |
| 1 | multipart |
| 2 | message |
| 3 | application |
| 4 | audio |
| 5 | image |
| 6 | video |
| 7 | other |
表 3. 通信時のエンコーディング
| 0 | 7BIT |
| 1 | 8BIT |
| 2 | BINARY |
| 3 | BASE64 |
| 4 | QUOTED-PRINTABLE |
| 5 | OTHER |