didou Wed Dec 10 12:11:52 2003 EDT
Modified files:
/phpdoc/en/reference/imap/functions imap-check.xml
Log:
corrected the doc (user note)
added example
Index: phpdoc/en/reference/imap/functions/imap-check.xml
diff -u phpdoc/en/reference/imap/functions/imap-check.xml:1.3
phpdoc/en/reference/imap/functions/imap-check.xml:1.4
--- phpdoc/en/reference/imap/functions/imap-check.xml:1.3 Wed Oct 9 10:55:05
2002
+++ phpdoc/en/reference/imap/functions/imap-check.xml Wed Dec 10 12:11:52 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
<refentry id="function.imap-check">
<refnamediv>
@@ -25,7 +25,8 @@
<itemizedlist>
<listitem>
<simpara>
- Date - last change of mailbox contents
+ Date - current system time formatted according to <ulink
+ url="&url.rfc;822">RFC822</ulink>
</simpara>
</listitem>
<listitem>
@@ -50,6 +51,41 @@
</listitem>
</itemizedlist>
</para>
+ <para>
+ <example>
+ <title><function>imap_check</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$imap_obj = imap_check($imap_stream);
+var_dump($imap_obj);
+
+?>
+]]>
+ </programlisting>
+ <para>
+ this will output :
+ </para>
+ <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="[EMAIL PROTECTED]"}INBOX"
+ ["Nmsgs"]=>
+ int(1)
+ ["Recent"]=>
+ int(0)
+}
+]]>
+ </screen>
+ </example>
+ </para>
</refsect1>
</refentry>
