array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.imap-fetchstructure.php', 1 => 'imap_fetchstructure', 2 => '特定のメッセージの構造を読み込む', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP 関数', ), 'prev' => array ( 0 => 'function.imap-fetchmime.php', 1 => 'imap_fetchmime', ), 'next' => array ( 0 => 'function.imap-fetchtext.php', 1 => 'imap_fetchtext', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/imap/functions/imap-fetchstructure.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_fetchstructure

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

imap_fetchstructure(IMAP\Connection $imap, int $message_num, int $flags = 0): stdClass|false

この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。

パラメータ

imap

IMAP\Connection クラスのインスタンス。

message_num

メッセージ番号。

flags

オプションのパラメータで、FT_UID のみが指定可能です。 これは、message_num を UID として処理することを関数に指定するためのものです。

戻り値

以下の表に示すプロパティを持つオブジェクトを返します。 失敗した場合に false を返します

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

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap resource が期待されていました。

参考