imap_ping
PHP function
Edit on GitHub ✎
(PHP 4, PHP 5, PHP 7, PHP 8)
Check if the IMAP stream is still active
Description
imap_ping(IMAP\Connection $imap): bool
imap_ping() pings the stream to see if it's still active. It may discover new mail; this is the preferred method for a periodic "new mail check" as well as a "keep alive" for servers which have inactivity timeout.
Parameters
Return Values
Returns true if the stream is still alive, false otherwise.
Changelog
| Version | Description |
|---|
Examples
imap_ping() Example
php
<?php
$imap = imap_open("{imap.example.org}", "mailadmin", "password");
// after some sleeping
if (!imap_ping($imap)) {
// do some stuff to reconnect
}
?>