imap-body.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-body" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_body</refname>
  <refpurpose>Read the message body</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>imap_body</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>
   <function>imap_body</function> returns the body of the message,
   numbered <parameter>message_num</parameter> in the current
   mailbox.
  </para>
  <para>
   <function>imap_body</function> will only return a verbatim copy of the
   message body. To extract single parts of a multipart MIME-encoded
   message you have to use <function>imap_fetchstructure</function> to
   analyze its structure and <function>imap_fetchbody</function> to
   extract a copy of a single body component.
  </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>
       The optional <parameter>flags</parameter> are a bit mask
       with one or more of the following:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>FT_UID</constant> - The <parameter>message_num</parameter> is a UID
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_PEEK</constant> - Do not set the \Seen flag if not already set
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_INTERNAL</constant> - The return string is in internal format, will
          not canonicalize to CRLF.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the body of the specified message, as a string, &return.falseforfailure;.
  </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>
 
</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
-->