Web aym.pekori.to

imap_fetchstructure

(PHP 3, PHP 4, PHP 5)

imap_fetchstructure --  特定のメッセージの構造を読み込む

説明

object imap_fetchstructure ( resource imap_stream, int msg_number [, int options] )

この関数は、指定したメッセージに関するすべての構造化された情報を 取り出します。オプションのパラメータ options に指定可能なのは FT_UID のみで、これは引数 msg_numberUID として処理することを関数に指定するためのものです。返されるオブジェクトには MIME の添付の各要素に類似のオブジェクトとしてエンベロープ、 内部の日付、サイズ、フラグ、本体を含んでいます。返される オブジェクトの構造は次のようになります。

表 1. imap_fetchstructure() で返されるオブジェクト

type最初の body 部の型
encodingbody 部を転送する際のエンコード法
ifsubtypesubtype文字列がある場合に TRUE
subtypeMIME の subtype
ifdescriptiondescription 文字列がある場合に TRUE
description内容を記述する文字列
ifididentification 文字列がある場合に TRUE
idIdentification 文字列
lines行数
bytesバイト数
ifdispositiondisposition 文字列がある場合に TRUE
dispositionDisposition 文字列
ifdparametersdparameters 配列が存在する場合に TRUE
dparametersオブジェクトの配列。各オブジェクトは "attribute" および "value" というプロパティを保持し、それぞれ Content-disposition MIME ヘッダの 対応するパラメータを表す。
ifparameters配列 parameters が存在する場合に TRUE
parametersオブジェクトの配列。各オブジェクトは "attribute" および "value" というプロパティを保持する。
partsオブジェクトの配列であり、その構造はトップレベルオブジェクトと 同じです。それぞれが MIME body 部に対応しています。

表 2. 最初のボディの型

0text
1multipart
2message
3application
4audio
5image
6video
7other

表 3. 通信時のエンコーディング

07BIT
18BIT
2BINARY
3BASE64
4QUOTED-PRINTABLE
5OTHER

imap_fetchbody() も参照ください。