この関数は、指定したメッセージに関するすべての構造化された情報を 取り出します。オプションのパラメータ options に指定可能なのは 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 | オブジェクトの配列。各オブジェクトは "attribute" および "value" というプロパティを保持し、それぞれ Content-disposition MIME ヘッダの 対応するパラメータを表す。 |
ifparameters | 配列 parameters が存在する場合に TRUE |
parameters | オブジェクトの配列。各オブジェクトは "attribute" および "value" というプロパティを保持する。 |
parts | オブジェクトの配列であり、その構造はトップレベルオブジェクトと 同じです。それぞれが MIME body 部に対応しています。 |
imap_fetchbody() も参照ください。