mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
133 lines
3.4 KiB
XML
133 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-mailboxmsginfo" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_mailboxmsginfo</refname>
|
|
<refpurpose>Get information about the current mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>imap_mailboxmsginfo</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Checks the current mailbox status on the server. It is similar to
|
|
<function>imap_status</function>, but will additionally sum up the size of
|
|
all messages in the mailbox, which will take some additional time to
|
|
execute.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-stream.description;
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the information in an object with following properties:
|
|
<table>
|
|
<title>Mailbox properties</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry>Date</entry>
|
|
<entry>date of last change (current datetime)</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Driver</entry>
|
|
<entry>driver</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Mailbox</entry>
|
|
<entry>name of the mailbox</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Nmsgs</entry>
|
|
<entry>number of messages</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Recent</entry>
|
|
<entry>number of recent messages</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Unread</entry>
|
|
<entry>number of unread messages</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Deleted</entry>
|
|
<entry>number of deleted messages</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Size</entry>
|
|
<entry>mailbox size</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
Returns &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_mailboxmsginfo</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
|
|
or die("can't connect: " . imap_last_error());
|
|
|
|
$check = imap_mailboxmsginfo($mbox);
|
|
|
|
if ($check) {
|
|
echo "Date: " . $check->Date . "<br />\n" ;
|
|
echo "Driver: " . $check->Driver . "<br />\n" ;
|
|
echo "Mailbox: " . $check->Mailbox . "<br />\n" ;
|
|
echo "Messages: " . $check->Nmsgs . "<br />\n" ;
|
|
echo "Recent: " . $check->Recent . "<br />\n" ;
|
|
echo "Unread: " . $check->Unread . "<br />\n" ;
|
|
echo "Deleted: " . $check->Deleted . "<br />\n" ;
|
|
echo "Size: " . $check->Size . "<br />\n" ;
|
|
} else {
|
|
echo "imap_check() failed: " . imap_last_error() . "<br />\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:"~/.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
|
|
-->
|