imap_ping

(PHP 4, PHP 5, PHP 7)

Check if the IMAP stream is still active

bool imap_ping ( resource $imap_stream )

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:

imap_stream

An IMAP stream returned by imap_open().

Returns:

Returns TRUE if the stream is still alive, FALSE otherwise.

Examples:

imap_ping() Example

<?php
 
$imap = imap_open("{imap.example.org}", "mailadmin", "password");
 
// after some sleeping
if (!imap_ping($imap)) {
    // do some stuff to reconnect
}
 
?>

Links:

http://php.net/manual/en/function.imap-ping.php

doc_php

2025-01-10 15:47:30

Comments