PHP 4, PHP 5, PHP 7, PHP 8
imap_ping - Check if the IMAP stream is still active
Code Examples

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 resource was expected.

Example of imap_ping

Show all examples for imap_ping

PHP Version:

Function imap_ping:

IMAP, POP3 and NNTP Functions

Most used PHP functions