imap_fetchstructure
特定のメッセージの構造を読み込む
&reftitle.description;
stdClassfalseimap_fetchstructure
IMAP\Connectionimap
intmessage_num
intflags0
この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。
&reftitle.parameters;
&imap.imap-parameter.imap;
message_num
メッセージ番号。
flags
オプションのパラメータで、FT_UID のみが指定可能です。
これは、message_num を UID
として処理することを関数に指定するためのものです。
&reftitle.returnvalues;
以下の表に示すプロパティを持つオブジェクトを返します。
&return.falseforfailure;
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 部に対応しています。
最初の body 部の型 (使用するライブラリによって異なるため、定数を使うことを推奨します)
値型定数
0textTYPETEXT
1multipartTYPEMULTIPART
2messageTYPEMESSAGE
3applicationTYPEAPPLICATION
4audioTYPEAUDIO
5imageTYPEIMAGE
6videoTYPEVIDEO
7modelTYPEMODEL
8otherTYPEOTHER
転送時のエンコーディング (使用するライブラリによって異なるため、定数を使うことを推奨します)
値型定数
07bitENC7BIT
18bitENC8BIT
2BinaryENCBINARY
3Base64ENCBASE64
4Quoted-PrintableENCQUOTEDPRINTABLE
5otherENCOTHER
&reftitle.changelog;
&Version;
&Description;
&imap.changelog.imap-param;
&reftitle.seealso;
imap_fetchbody
imap_bodystruct