imap_fetchstructure()

imap_fetchstructure - Read the structure of a particular message

Syntax

object imap_fetchstructure (resource $imap_stream, int $msg_number, int $options)

Arguments

• imap_stream - An IMAP stream returned by imap_open().
• msg_number - The message number
• options - This optional parameter only has a single option, FT_UID, which tells the function to treat the msg_number argument as a UID.

Description

Fetches all the structured information for a given message.

Version

PHP 4, 5

Return value

Returns an object includes the envelope, internal date, size, flags and body structure along with a similar object for each mime attachment. The structure of the returned objects is as follows: