corrected the doc (user note)

added example


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146135 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2003-12-10 17:11:52 +00:00
parent 74d92d6b3f
commit 39dd8a1e84

View file

@ -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="foo@example.com"}INBOX"
["Nmsgs"]=>
int(1)
["Recent"]=>
int(0)
}
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>