php-doc-en/reference/imap/functions/imap-fetch-overview.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<refentry id="function.imap-fetch-overview">
 <refnamediv>
  <refname>imap_fetch_overview</refname>
  <refpurpose>Read an overview of the information in the headers of the given message</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>array</type><methodname>imap_fetch_overview</methodname>
   <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
   <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function fetches mail headers for the given
   <parameter>sequence</parameter> and returns an overview of their
   contents. <parameter>sequence</parameter> will contain a sequence
   of message indices or UIDs, if <parameter>flags</parameter>
   contains FT_UID. The returned value is an array of objects
   describing one message header each:
   <itemizedlist>
    <listitem>
     <simpara>
      subject - the messages subject
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      from - who sent it
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      to - recipient
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      date - when was it sent
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      message_id - Message-ID
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      references - is a reference to this message id
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      in_reply_to - is a reply to this message id
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      size - size in bytes
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      uid - UID the message has in the mailbox
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      msgno - message sequence number in the mailbox
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      recent - this message is flagged as recent
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      flagged -  this message is flagged
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      answered -  this message is flagged as answered
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      deleted -  this message is flagged for deletion
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      seen -  this message is flagged as already read
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      draft -  this message is flagged as being a draft
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   <example>
    <title><function>imap_fetch_overview</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password")
     or die("can't connect: " . imap_last_error());

$overview = imap_fetch_overview($mbox, "2,4:6", 0);

if (is_array($overview)) {
    foreach ($overview as $val) {
        echo "$val->msgno - $val->date - $val->subject\n";
    }
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </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
-->