imap_status

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_status — Отримує інформацію про статус поштової скриньки

Опис

imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false

Повертає інформацію про статус заданого у параметрі 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()****

Loading...