imap_ping

Check if the IMAP stream is still active

&reftitle.description; `bool` `imap_ping` `IMAP\Connection` `imap`

`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.

&reftitle.parameters;

&imap.imap-parameter.imap;
&reftitle.returnvalues;

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

&reftitle.changelog;

&Version; | &Description;
&imap.changelog.imap-param;

&reftitle.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
    }

    ?>