Home/ Manual/ imap / functions/ imap_fetchstructure

imap_fetchstructure

PHP function Edit on GitHub ✎

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

Read the structure of a particular message

Description

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

Fetches all the structured information for a given message.

message_num: The message number
flags: This optional parameter only has a single option, FT_UID, which tells the function to treat the message_num argument as a UID.

Returns an object with properties listed in the table below, Falseforfailure.

type	Primary body type
encoding	Body transfer encoding
ifsubtype	true if there is a subtype string
subtype	MIME subtype
ifdescription	true if there is a description string
description	Content description string
ifid	true if there is an identification string
id	Identification string
lines	Number of lines
bytes	Number of bytes
ifdisposition	true if there is a disposition string
disposition	Disposition string
ifdparameters	true if the `dparameters` array exists
dparameters	An array of objects where each object has an `"attribute"` and a `"value"` property corresponding to the parameters on the `Content-disposition` MIME header.
ifparameters	true if the parameters array exists
parameters	An array of objects where each object has an `"attribute"` and a `"value"` property.
parts	An array of objects identical in structure to the top-level object, each of which corresponds to a MIME body part.

Version	Description