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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7f569e1f175adf1fbd0e462eba8d6bc82214c939 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: yes Maintainer: lex -->

<refentry xml:id="function.imap-fetch-overview" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_fetch_overview</refname>
  <refpurpose>Обзор информации, содержащейся в заголовках сообщений</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <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><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Эта функция читает заголовки сообщений, заданных в
   <parameter>sequence</parameter> и возвращает обзорную информацию
   об их контенте.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-stream.description;
    <varlistentry>
     <term><parameter>sequence</parameter></term>
     <listitem>
      <para>
       Последовательность номеров сообщений.Вы можете перечислить несколько
       сообщений, используя как разделитель запятую (<literal>X,Y</literal>), или
       задать интервал сообщений с помощью двоеточия <literal>X:Y</literal>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>sequence</parameter> должен содержать номера сообщений.
       Если вы хотите задать в нем их UID, то этот параметр необходимо
       задать значением <constant>FT_UID</constant>. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает массив объектов, каждый из которых описывает заголовок одного сообщения.
   Объекты содержат соответствующие свойства только если они присутствуют.
   Возможные свойства:
   <itemizedlist>
    <listitem>
     <simpara>
      <literal>subject</literal> - тема письма
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>from</literal> - кто его послал
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>to</literal> - получатель
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>date</literal> - когда оно было послано
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>message_id</literal> - Идентификатор сообщения
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>references</literal> - является ссылкой на этот идентификатор сообщения
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>in_reply_to</literal> - является ответом на письмо с этим идентификатором
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>size</literal> - размер в байтах
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>uid</literal> - UID сообщения в ящике
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>msgno</literal> - номер сообщения в ящике
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>recent</literal> - письмо помечено как новое
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>flagged</literal> -  это сообщение помечено (обычно является признаком 
      "важности")
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>answered</literal> -  сообщение помечано как отвеченное
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>deleted</literal> -  помечено для удаления
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>seen</literal> -  помечено как прочитанное
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>draft</literal> -  помечено как черновик
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>udate</literal> -  временная метка UNIX даты получения
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>imap_fetch_overview</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
     or die("не удалось подключиться: " . imap_last_error());

$MC = imap_check($mbox);

// Получим обзор всех писем в INBOX
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach ($result as $overview) {
    echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
    {$overview->subject}\n";
}
imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_fetchheader</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
-->