imap_ping()

imap_ping - Check if the IMAP stream is still active

Syntax

bool imap_ping (resource $imap_stream)

Arguments

• imap_stream - An IMAP stream returned by imap_open().

Description

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.

Version

PHP 4, 5

Return value

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