imap_check

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

imap_checkПроверяет текущий почтовый ящик

Описание

imap_check(IMAP\Connection $imap): stdClass|false

Проверяет информацию текущего почтового ящика.

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

imap

Экземпляр класса IMAP\Connection.

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

Возвращает объект со следующими свойствами:

  • Date - текущее системное время в формате соответствующем » RFC2822
  • Driver - протокол, используемый для доступа к почтовому ящику: POP3, IMAP, NNTP
  • Mailbox - имя почтового ящика
  • Nmsgs - количество сообщений
  • Recent - количество новых сообщений

В случае возникновения ошибки возвращает false.

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.

Примеры

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

<?php

$imap
= imap_check($imap_stream);
var_dump($imap);

?>

Вывод приведённого примера будет похож на:

object(stdClass)(5) {
  ["Date"]=>
  string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}