imap_fetchstructure

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

説明

object imap_fetchstructure(int imap_stream, int msg_number, int [flags] );

この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。 オプションのパラメータ flags に指定可能なのは 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 [a] Disposition parameter array
ifparameters配列 parameters が存在する場合に true
parameters [b] MIME パラメータ配列
parts [c] 各メッセージパートを記述するオブジェクトの配列
注意:
a dparameters はオブジェクトの配列です。 各オブジェクトは、プロパティ "attribute" および "value" を有しています。
b parameter はオブジェクトの配列です。各オブジェクトは、 プロパティ "attributte" および "value" を有しています。
c parts はオブジェクトの配列であり、最上位のオブジェクト と構造が同じです。ただし、'parts' オブジェクトを含むことが できないという制限があります。

表 2. 最初のボディー部の型

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

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

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