SunshinePHP 2020 CFP Started


(PHP 4, PHP 5, PHP 7)

imap_statusПолучить информацию по статусу почтового ящика


imap_status ( resource $imap_stream , string $mailbox , int $options ) : object

Возвращает информацию по статусу заданного ящика mailbox.

Список параметров


Поток IMAP, полученный из imap_open().


Имя почтового ящика, более подробно смотрите в описании imap_open()


Если imap.enable_insecure_rsh не отключен, то передача в этот параметр не проверенных данных не безопасна.


Допустимые опции:

  • SA_MESSAGES - установить $status->messages, равным количеству писем в ящике
  • SA_RECENT - установить $status->recent, равным количеству новых писем
  • SA_UNSEEN - установить $status->unseen, равным количеству непрочтенных писем
  • SA_UIDNEXT - установить $status->uidnext равным следующему uid, который будет использован в ящике
  • SA_UIDVALIDITY - установить $status->uidvalidity в значение константы, которая меняется, когда UID для почтового ящика больше не могут быть действительным
  • SA_ALL - использовать все перечисленные опции

Возвращаемые значения

Функция возвращает объект, содержащий информацию по статусу. Объект имеет следующие свойства: messages, recent, unseen, uidnext и uidvalidity.

flags также установлен, он содержит битовую маску которая может быть проверена с помощью перечисленных выше констант.


Пример #1 Пример использования imap_status()

      or die(
"не удалось подключиться: " imap_last_error());

$status imap_status($mbox"{}INBOX"SA_ALL);
if (
$status) {
"Сообщения:   " $status->messages    "<br />\n";
"Последние:     " $status->recent      "<br />\n";
"Непросмотренные:     " $status->unseen      "<br />\n";
"UIDnext:    " $status->uidnext     "<br />\n";
"UIDvalidity:" $status->uidvalidity "<br />\n";
} else {
"imap_status failed: " imap_last_error() . "\n";


add a note add a note

User Contributed Notes 3 notes

jille at DIESPAMMERShexon dot cx
12 years ago
In 'reply' to my previous post;
I`m not sure of that anymore
I think this trick works,
but the rest of my script just sucks..

You can get the last UID by using status->uidnext-1
BUT: This is not a good way, if another message is added after your append and before your status; you are screwed
mwwaygoo AT hotmail DOT com
7 years ago
I had issues with imap_status not working correctly, while other imap functions seemed okay. I always got the ['flags']=0 response. No notes here and Google searching suggests it doesn't working properly with Exchange, so I wrote a little workaround, to at least get some information.

function my_imap_status($stream, $mailbox='', $info=SA_ALL)
// get current mailbox name (and info)
$curr_obj) return false;
// if request if for current mailbox then just return it
if( (empty($mailbox)) || ($mailbox==$curr_obj->Mailbox) ) return $curr_obj;
// get current mailbox
//switch to new mailbox
if(!imap_reopen($stream, $mailbox)) return false;
// get info
// switch back to original mailbox
imap_reopen($stream, $current_mailbox);
//return info
return $obj;
razonklnbd at hotmail dot com
11 years ago
another tips is to get only total number of message and recent message

$imap_obj = imap_status($mbox, '{}INBOX', SA_MESSAGES+SA_RECENT);
echo('<pre>'); var_dump($imap_obj); echo('</pre>');
To Top