CakeFest 2024: The Official CakePHP Conference

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)
}

add a note

User Contributed Notes 4 notes

up
3
Anonymous
19 years ago
You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.
up
1
erik at phpcastle dot com
18 years ago
The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
up
1
JUNIOR TELLO
18 years ago
You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.
up
1
rasmus at flajm dot com
20 years ago
Running this on a mailbox will mark recent/new messages as checked.
To Top