PHP Manual
PrevNext

imap_fetchstructure

(PHP 3, PHP 4 )

imap_fetchstructure --  Read the structure of a particular message

Description

object imap_fetchstructure (int imap_stream, int msg_number [, int flags])

This function fetches all the structured information for a given message. The optional flags parameter only has a single option, FT_UID, which tells the function to treat the msg_number argument as a UID. The returned object includes the envelope, internal date, size, flags and body structure along with a similar object for each mime attachement. The structure of the returned objects is as follows:

Table 1. Returned Objects for imap_fetchstructure()

typePrimary body type
encodingBody transfer encoding
ifsubtypeTrue if there is a subtype string
subtypeMIME subtype
ifdescriptionTrue if there is a description string
descriptionContent description string
ifidTrue if there is an identification string
idIdentification string
linesNumber of lines
bytesNumber of bytes
ifdispositionTrue if there is a disposition string
dispositionDisposition string
ifdparametersTrue if the dparameters array exists