array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'es', ), 'this' => array ( 0 => 'function.imap-status.php', 1 => 'imap_status', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Funciones', ), 'prev' => array ( 0 => 'function.imap-sort.php', 1 => 'imap_sort', ), 'next' => array ( 0 => 'function.imap-subscribe.php', 1 => 'imap_subscribe', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/imap/functions/imap-status.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_status — Returns status information on a mailbox
Gets status information about the given mailbox
.
imap
An IMAP\Connection instance.
mailbox
The mailbox name, see imap_open() for more information
El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.
flags
Valid flags are:
SA_MESSAGES
- set $status->messages to the
number of messages in the mailbox
SA_RECENT
- set $status->recent to the number
of recent messages in the mailbox
SA_UNSEEN
- set $status->unseen to the number
of unseen (new) messages in the mailbox
SA_UIDNEXT
- set $status->uidnext to the next
uid to be used in the mailbox
SA_UIDVALIDITY
- set $status->uidvalidity to a
constant that changes when uids for the mailbox may no longer be
valid
SA_ALL
- set all of the above
This function returns an object containing status information, o false
en caso de error.
The object has the following properties: messages
,
recent
, unseen
,
uidnext
, and uidvalidity
.
flags
is also set, which contains a bitmask which can
be checked against any of the above constants.
Versión | Descripción |
---|---|
8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap recurso was expected.
|
Ejemplo #1 imap_status() example
<?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);
?>