PHP 8.1.28 Released!


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

imap_pingCheck if the IMAP stream is still active


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.



An IMAP\Connection instance.

Return Values

Returns true if the stream is still alive, false otherwise.


Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.


Example #1 imap_ping() Example


= imap_open("{}", "mailadmin", "password");

// after some sleeping
if (!imap_ping($imap)) {
// do some stuff to reconnect


add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top