imap_fetchstructure

imap_fetchstructure -- Read the structure of a particular message

Description

array imap_fetchstructure(int imap_stream, int msg_number);

This function causes a fetch of all the structured information for the given msg_number. The returned value is an object with following elements.

 type, encoding, ifsubtype, subtype, ifdescription, description, ifid,
 id, lines, bytes, ifparameters
      

It also returns an array of objects called parameters[]. This object has following properties.

attribute, value
      

In case of multipart, it also returns an array of objects of all the properties, called parts[].