array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'function.imap-status.php', 1 => 'imap_status', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'Функции IMAP', ), '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' => 'ru', '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 — Получает информацию по статусу почтового ящика
Возвращает информацию по статусу заданного в параметре mailbox
ящика.
imap
Экземпляр класса IMAP\Connection.
mailbox
Имя почтового ящика, более подробно смотрите в описании imap_open()
Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не проверенных данных не безопасна.
flags
Допустимые опции:
SA_MESSAGES
- установить
$status->messages, равным количеству писем в ящике
SA_RECENT
- установить
$status->recent, равным количеству новых писем
SA_UNSEEN
- установить
$status->unseen, равным количеству непрочитанных писем
SA_UIDNEXT
- установить
$status->uidnext равным следующему uid, который будет
использован в ящике
SA_UIDVALIDITY
- установить
$status->uidvalidity в значение константы, которая меняется,
когда UID для почтового ящика больше не могут быть действительным
SA_ALL
- использовать все перечисленные опции
Функция возвращает объект, содержащий информацию по статусу или false
, если возникла ошибка.
Объект имеет следующие свойства: messages
,
recent
, unseen
,
uidnext
и uidvalidity
.
flags
также установлен, он содержит битовую маску которая может
быть проверена с помощью перечисленных выше констант.
Версия | Описание |
---|---|
8.1.0 |
Параметр imap теперь ожидает экземпляр класса IMAP\Connection;
раньше параметр ждал ресурс (resource) imap .
|
Пример #1 Пример использования imap_status()
<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . imap_last_error());
$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
echo "Сообщения: " . $status->messages . "<br />\n";
echo "Последние: " . $status->recent . "<br />\n";
echo "Непросмотренные: " . $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);
?>