imap_ping

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

imap_pingПроверить, активен ли ещё поток IMAP

Описание

imap_ping(IMAP\Connection $imap): bool

imap_ping() проверяет, активен ли ещё открытый поток. С помощью него можно узнавать, есть ли новая почта. Это предпочтительный метод проверять есть ли новые сообщения и аналог "keep alive" для серверов с настроенным временем ожидания неактивности.

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

imap

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

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

Возвращает true, если поток активен и false, если нет.

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

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

Примеры

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

<?php

$imap
= imap_open("{imap.example.org}", "mailadmin", "password");

// после некоторого ожидания
if (!imap_ping($imap)) {
// производим переподключение
}

?>