imap_ping

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

    imap_ping — Check if the IMAP stream is still active

    Descripción

    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.

    Parámetros

    imap

    An IMAP\Connection instance.

    Valores devueltos

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

    Historial de cambios

    VersiónDescripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imaprecurso was expected.

    Ejemplos

    Ejemplo #1 imap_ping() Example

    <?php

    $imap     = imap_open("{imap.example.org}", "mailadmin", "password");

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

    ?>
    To Top