imap-mailboxmsginfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 848fab73ae9c1c1100c79c9c4a62357815b4a131 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-mailboxmsginfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_mailboxmsginfo</refname>
  <refpurpose>Получает информацию о текущем почтовом ящике</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>stdClass</type><methodname>imap_mailboxmsginfo</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
  </methodsynopsis>
  <para>
   Проверяет статус текущего почтового ящика на сервере. Аналогично
   <function>imap_status</function>, но дополнительно вычисляет суммарный
   размер всех писем в ящике, из-за чего работает несколько медленнее.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает объект со следующими полями:
   <table>
    <title>Свойства почтового ящика</title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry>Date</entry>
       <entry>дата последнего изменения (текущие дата и время)</entry>
      </row>
      <row>
       <entry>Driver</entry>
       <entry>драйвер</entry>
      </row>
      <row>
       <entry>Mailbox</entry>
       <entry>имя почтового ящика</entry>
      </row>
      <row>
       <entry>Nmsgs</entry>
       <entry>количество писем</entry>
      </row>
      <row>
       <entry>Recent</entry>
       <entry>количество новых</entry>
      </row>
      <row>
       <entry>Unread</entry>
       <entry>количество непрочитанных</entry>
      </row>
      <row>
       <entry>Deleted</entry>
       <entry>количество удалённых</entry>
      </row>
      <row>
       <entry>Size</entry>
       <entry>размер ящика</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="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>imap_mailboxmsginfo</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
      or die("не удалось подключиться: " . imap_last_error());

$check = imap_mailboxmsginfo($mbox);

if ($check) {
    echo "Date: "     . $check->Date    . "<br />\n" ;
    echo "Driver: "   . $check->Driver  . "<br />\n" ;
    echo "Mailbox: "  . $check->Mailbox . "<br />\n" ;
    echo "Messages: " . $check->Nmsgs   . "<br />\n" ;
    echo "Recent: "   . $check->Recent  . "<br />\n" ;
    echo "Unread: "   . $check->Unread  . "<br />\n" ;
    echo "Deleted: "  . $check->Deleted . "<br />\n" ;
    echo "Size: "     . $check->Size    . "<br />\n" ;
} else {
    echo "Вызов imap_mailboxmsginfo() завершился с ошибкой: " . imap_last_error() . "<br />\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:"~/.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
-->