imap-fetch-overview.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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 class="union"><type>array</type><type>false</type></type><methodname>imap_fetch_overview</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция извлекает заголовки писем по последовательности, которую передали
   в аргументе <parameter>sequence</parameter>, и возвращает обзорную информацию
   содержания заголовков.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>sequence</parameter></term>
     <listitem>
      <para>
       Описание последовательности сообщений. Сообщения перечисляют
       синтаксисом <literal>X,Y</literal> или получают все сообщения
       в пределах интервала синтаксисом <literal>X:Y</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</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> — содержимое заголовка 'In-Reply-To' ответа на идентификатор сообщения
     </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>
   Функция возвращает &false;, если возникла ошибка.
  </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="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}) — От: {$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
-->