PHP Manual
Prev |  | Next

# imap_ping

(PHP 3, PHP 4, PHP 5)

imap_ping -- Check if the IMAP stream is still active

## Description

bool imap_ping ( resource imap_stream )

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

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.

Example 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 } ?>`

Prev | Home | Next
imap_open | Up | imap_qprint