cvs: /phpdoc/functions imap.sgml

eschmid Fri Nov 26 12:12:49 1999 EDT Modified files: /phpdoc/functions imap.sgml Log: imap_fetchstructure rewrite. Index: phpdoc/functions/imap.sgml diff -u phpdoc/functions/imap.sgml:1.10 phpdoc/functions/imap.sgml:1.11 --- phpdoc/functions/imap.sgml:1.10 Sat Nov 20 09:22:56 1999 +++ phpdoc/functions/imap.sgml Fri Nov 26 12:12:49 1999 @@ -278,33 +278,125 @@ <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>array <function>imap_fetchstructure</function></funcdef> + <funcdef>object <function>imap_fetchstructure</function></funcdef> <paramdef>int <parameter>imap_stream</parameter></paramdef> <paramdef>int <parameter>msg_number</parameter></paramdef> + <paramdef>int + <parameter><optional>flags</optional></parameter> + </paramdef> </funcsynopsis> <para> - This function causes a fetch of all the structured information - for the given <parameter>msg_number</parameter>. The returned - value is an object with following elements.</para> - <para> - - <informalexample> - <literallayout> - type, encoding, ifsubtype, subtype, ifdescription, description, ifid, - id, lines, bytes, ifparameters - </literallayout> - </informalexample></para> + This function fetches all the structured information for a given + message. The optional <parameter>flags</parameter> parameter only + has a single option, <parameter>FT_UID</parameter>, which tells + the function to treat the <parameter>msg_number</parameter> + argument as a <parameter>UID</parameter>. 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: + </para> <para> - It also returns an array of objects called parameters[]. This - object has following properties. - - <informalexample> - <literallayout> - attribute, value - </literallayout> - </informalexample> - In case of multipart, it also returns an array of objects of all - the properties, called parts[].</para> + <table> + <title> + Returned Objects for <function>imap_fetchstructure</function> + </title> + <tgroup cols="2"> + <tbody> + <row> + <entry>type</entry> + <entry>Primary body type</entry> + </row> + <row> + <entry>encoding</entry> + <entry>Body transfer encoding</entry> + </row> + <row> + <entry>ifsubtype</entry> + <entry>True if there is a subtype string</entry> + </row> + <row> + <entry>subtype</entry> + <entry><acronym>MIME</acronym> subtype</entry> + </row> + <row> + <entry>ifdescription</entry> + <entry>True if there is a description string</entry> + </row> + <row> + <entry>description</entry> + <entry>Content description string</entry> + </row> + <row> + <entry>ifid</entry> + <entry>True if there is an identification string</entry> + </row> + <row> + <entry>id</entry> + <entry>Identification string</entry> + </row> + <row> + <entry>lines</entry> + <entry>Number of lines</entry> + </row> + <row> + <entry>bytes</entry> + <entry>Number of bytes</entry> + </row> + <row> + <entry>ifdisposition</entry> + <entry>True if there is a disposition string</entry> + </row> + <row> + <entry>disposition</entry> + <entry>Disposition string</entry> + </row> + <row> + <entry>ifdparameters</entry> + <entry>True if the dparameters array exists</entry> + </row> + <row> + <entry>dparameters + <footnote> + <para> + dparameters is an array of objects where each object has + an "attribute" and a "value" property. + </para> + </footnote> + </entry> + <entry>Disposition parameter array</entry> + </row> + <row> + <entry>ifparameters</entry> + <entry>True if the parameters array exists</entry> + </row> + <row> + <entry>parameters + <footnote> + <para> + parameter is an array of objects where each object has an + "attributte" and a "value" property. + </para> + </footnote> + </entry> + <entry><acronym>MIME</acronym> parameters array</entry> + </row> + <row> + <entry>parts + <footnote> + <para> + parts is an array of objects identical in structure to the + top-level object, with the limitation that it cannot + contain further 'parts' objects. + </para> + </footnote> + </entry> + <entry>Array of objects describing each message part</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> </refsect1> </refentry>