imap_ping
Name
imap_ping — Pings an IMAP server
Synopsis
bool imap_ping
(connection);
int connection: IMAP
connection ID
Returns
TRUE if alive; FALSE on error
Description
Pings an IMAP server specified from the imap_open() function. This is
useful for testing if a connection has been established,
preventing server timeout and checking for new mailbox
messages.
Version
From versions 3.0 and 4.0
Example
Example 614. Ping an IMAP
server
<?php
$imap = imap_open("{localhost}mbox-bak","graeme","inferno");
if (imap_ping($imap)) {
echo "Yep, server is still there";
} else {
echo "Server has gone away!";
}
?>
PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing
(Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch).
This material may be distributed only subject to the terms and conditions set forth
in the Open Publication License, v1.0 or later (the latest version is presently available at
http://www.opencontent.org/openpub/).
The authors of this book have elected not to choose any options under the OPL. This online book was obtained
from
http://www.fooassociates.com/phpfer/
and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4
for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All
persons and entities shall have neither liability nor responsibility to any person or entity with respect to
any loss or damage arising from the information contained in this book.