<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-fetchstructure" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_fetchstructure</refname>
  <refpurpose>Read the structure of a particular message</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_fetchstructure</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>int</type><parameter>message_num</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Fetches all the structured information for a given message. 
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_num</parameter></term>
     <listitem>
      <para>
       The message number
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       This optional parameter only has a single option, 
       <constant>FT_UID</constant>, which tells the function to treat the
       <parameter>message_num</parameter> argument as a 
       <literal>UID</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an object with properties listed in the table below, &return.falseforfailure;.
  </para>
  <para>
   <table>
    <title>
     Returned Object 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 <varname>dparameters</varname> array exists</entry>
      </row>
      <row>
       <entry>dparameters</entry>
       <entry>An array of objects where each object has an
        <literal>"attribute"</literal> and a <literal>"value"</literal>
        property corresponding to the parameters on the
        <literal>Content-disposition</literal> <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
        <literal>"attribute"</literal> and a <literal>"value"</literal>
        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 (value may vary with used library, use of constants is recommended)</title>
    <tgroup cols="3">
     <thead>
      <row><entry>Value</entry><entry>Type</entry><entry>Constant</entry></row>
     </thead>
     <tbody>
      <row><entry>0</entry><entry>text</entry><entry>TYPETEXT</entry></row>
      <row><entry>1</entry><entry>multipart</entry><entry>TYPEMULTIPART</entry></row>
      <row><entry>2</entry><entry>message</entry><entry>TYPEMESSAGE</entry></row>
      <row><entry>3</entry><entry>application</entry><entry>TYPEAPPLICATION</entry></row>
      <row><entry>4</entry><entry>audio</entry><entry>TYPEAUDIO</entry></row>
      <row><entry>5</entry><entry>image</entry><entry>TYPEIMAGE</entry></row>
      <row><entry>6</entry><entry>video</entry><entry>TYPEVIDEO</entry></row>
      <row><entry>7</entry><entry>model</entry><entry>TYPEMODEL</entry></row>
      <row><entry>8</entry><entry>other</entry><entry>TYPEOTHER</entry></row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <para>
   <table>
    <title>Transfer encodings (value may vary with used library, use of constants is recommended)</title>
    <tgroup cols="3">
     <thead>
      <row><entry>Value</entry><entry>Type</entry><entry>Constant</entry></row>
     </thead>
     <tbody>
      <row><entry>0</entry><entry>7bit</entry><entry>ENC7BIT</entry></row>
      <row><entry>1</entry><entry>8bit</entry><entry>ENC8BIT</entry></row>
      <row><entry>2</entry><entry>Binary</entry><entry>ENCBINARY</entry></row>
      <row><entry>3</entry><entry>Base64</entry><entry>ENCBASE64</entry></row>
      <row><entry>4</entry><entry>Quoted-Printable</entry><entry>ENCQUOTEDPRINTABLE</entry></row>
      <row><entry>5</entry><entry>other</entry><entry>ENCOTHER</entry></row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_fetchbody</function></member>
    <member><function>imap_bodystruct</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->
