imap-check.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-check" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_check</refname>
  <refpurpose>Check current mailbox</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_check</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
  </methodsynopsis>
  <para>
   Checks information about the current mailbox.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the information in an object with following properties:
   <itemizedlist>
    <listitem>
     <simpara>
      <constant>Date</constant> - current system time formatted according to <link
      xlink:href="&url.rfc;2822">RFC2822</link>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Driver</constant> - protocol used to access this mailbox:
      <acronym>POP3</acronym>, <acronym>IMAP</acronym>, <acronym>NNTP</acronym>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Mailbox</constant> - the mailbox name
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Nmsgs</constant> - number of messages in the mailbox
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Recent</constant> - number of recent messages in the mailbox
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   Returns &false; on failure.
  </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_check</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$imap = imap_check($imap_stream);
var_dump($imap);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
object(stdClass)(5) {
  ["Date"]=>
  string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}
]]>
    </screen>
   </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
-->