mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 02:18:56 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
110 lines
3.2 KiB
XML
110 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-status">
|
|
<refnamediv>
|
|
<refname>imap_status</refname>
|
|
<refpurpose>
|
|
This function returns status information on a mailbox other than
|
|
the current one
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>imap_status</methodname>
|
|
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns an object containing status
|
|
information. Valid flags are:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
SA_MESSAGES - set status->messages to the number of messages
|
|
in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
SA_RECENT - set status->recent to the number of recent
|
|
messages in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
SA_UNSEEN - set status->unseen to the number of unseen (new)
|
|
messages in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
SA_UIDNEXT - set status->uidnext to the next uid to be used in
|
|
the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
SA_UIDVALIDITY - set status->uidvalidity to a constant that
|
|
changes when uids for the mailbox may no longer be valid
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
SA_ALL - set all of the above
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
status->flags is also set, which contains a bitmask which can be
|
|
checked against any of the above constants.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_status</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
$mbox = imap_open("{your.imap.host}","username","password",OP_HALFOPEN)
|
|
or die("can't connect: ".imap_last_error());
|
|
|
|
$status = imap_status($mbox,"{your.imap.host}INBOX",SA_ALL);
|
|
if($status) {
|
|
print("Messages: ". $status->messages )."<br>\n";
|
|
print("Recent: ". $status->recent )."<br>\n";
|
|
print("Unseen: ". $status->unseen )."<br>\n";
|
|
print("UIDnext: ". $status->uidnext )."<br>\n";
|
|
print("UIDvalidity:". $status->uidvalidity)."<br>\n";
|
|
} else
|
|
print "imap_status failed: ".imap_last_error()."\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:"../../../../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
|
|
-->
|