mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
7988eb137a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279806 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
4.4 KiB
XML
146 lines
4.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.14 $ -->
|
|
<refentry xml:id="function.imap-status" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_status</refname>
|
|
<refpurpose>Returns status information on a mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>imap_status</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets status information about the given <parameter>mailbox</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-stream.description;
|
|
<varlistentry>
|
|
<term><parameter>mailbox</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mailbox name, see <function>imap_open</function> for more
|
|
information
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Valid flags are:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_MESSAGES</constant> - set <varname>$status->messages</varname> to the
|
|
number of messages in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_RECENT</constant> - set <varname>$status->recent</varname> to the number
|
|
of recent messages in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_UNSEEN</constant> - set <varname>$status->unseen</varname> to the number
|
|
of unseen (new) messages in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_UIDNEXT</constant> - set <varname>$status->uidnext</varname> to the next
|
|
uid to be used in the mailbox
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_UIDVALIDITY</constant> - set <varname>$status->uidvalidity</varname> to a
|
|
constant that changes when uids for the mailbox may no longer be
|
|
valid
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SA_ALL</constant> - set all of the above
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
This function returns an object containing status information.
|
|
The object has the following properties: <literal>messages</literal>,
|
|
<literal>recent</literal>, <literal>unseen</literal>,
|
|
<literal>uidnext</literal>, and <literal>uidvalidity</literal>.
|
|
</para>
|
|
<para>
|
|
<literal>flags</literal> is also set, which contains a bitmask which can
|
|
be checked against any of the above constants.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_status</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
|
|
or die("can't connect: " . imap_last_error());
|
|
|
|
$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
|
|
if ($status) {
|
|
echo "Messages: " . $status->messages . "<br />\n";
|
|
echo "Recent: " . $status->recent . "<br />\n";
|
|
echo "Unseen: " . $status->unseen . "<br />\n";
|
|
echo "UIDnext: " . $status->uidnext . "<br />\n";
|
|
echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
|
|
} else {
|
|
echo "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
|
|
-->
|