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)) {
    // производим переподключение
}

?>

add a note

User Contributed Notes 1 note

down

-18

Anonymous ¶

21 years ago


This is a great solution for a webmail class if you want to make sure that a user is still logged in. Example:

<?php
if(!(imap_ping($stream)) {
die("The user is no longer logged in.");
?>

add a note