imap_fetchstructure

(PHP 3, PHP 4 )

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

説明

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 特性パラメータ配列
ifparameters 配列parametersが存在する場合に TRUE
parameters MIME パラメータ配列
parts 各メッセージパートを記述するオブジェクトの配列


  1. dparametersはオブジェクトの配列です。 各オブジェクトはプロパティ"attribute"および"value"を有しています。

  2. parameterはオブジェクトの配列です。 各オブジェクトはプロパティ"attribute"および"value"を有しています。

  3. partsはオブジェクトの配列であり、その構造はトップレベルオブジェクト と同じです。ただし、'parts'オブジェクトを更に追加できないという制限 があります。

表 2最初のボディーの型

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


imap_fetchbody() も参照下さい。