php-doc-en/reference/imap/functions/imap-fetchstructure.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
  <refentry id="function.imap-fetchstructure">
   <refnamediv>
    <refname>imap_fetchstructure</refname> 
    <refpurpose>
     Read the structure of a particular message
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_fetchstructure</methodname>
      <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function fetches all the structured information for a given
     message. The optional <parameter>options</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
     attachment. The structure of the returned objects is as follows:
    </para>
    <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</entry>
         <entry>An array of objects where each object has an "attribute" and a
         "value" property corresponding to the parameters on the
         Content-disposition <acronym>MIME</acronym>header.</entry>
        </row>
        <row>
         <entry>ifparameters</entry>
         <entry>&true; if the parameters array exists</entry>
        </row>
        <row>
         <entry>parameters</entry>
         <entry>An array of objects where each object has an "attribute" and
         a "value" property.</entry>
        </row>
        <row>
         <entry>parts</entry>
         <entry>An array of objects identical in structure to the top-level
         object, each of which corresponds to a <acronym>MIME</acronym> body
         part.</entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <table>
       <title>Primary body type</title>
       <tgroup cols="2">
        <tbody>
        <row><entry>0</entry><entry>text</entry></row>
        <row><entry>1</entry><entry>multipart</entry></row>
        <row><entry>2</entry><entry>message</entry></row>
        <row><entry>3</entry><entry>application</entry></row>
        <row><entry>4</entry><entry>audio</entry></row>
        <row><entry>5</entry><entry>image</entry></row>
        <row><entry>6</entry><entry>video</entry></row>
        <row><entry>7</entry><entry>other</entry></row>
        </tbody>
       </tgroup>
     </table>
    </para>
    <para>
     <table>
       <title>Transfer encodings</title>
       <tgroup cols="2">
        <tbody>
        <row><entry>0</entry><entry>7BIT</entry></row>
        <row><entry>1</entry><entry>8BIT</entry></row>
        <row><entry>2</entry><entry>BINARY</entry></row>
        <row><entry>3</entry><entry>BASE64</entry></row>
        <row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row>
        <row><entry>5</entry><entry>OTHER</entry></row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     See also: <function>imap_fetchbody</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->