(PHP 4, PHP 5, PHP 7, PHP 8)
imap_ping — IMAP ストリームがアクティブかどうかを調べる
imap_ping() はストリームに ping を行い、 まだアクティブであるかどうかを調べます。これにより新しいメールの到着を知ることもあります。 これは、定期的に「メールのチェック」を行い、サーバーとの 「接続を保持し続ける」ためのお勧めの方法です。
ストリームがまだ有効であれば true を、そうでなければ false を返します。
| バージョン | 説明 |
|---|---|
| 8.1.0 |
引数 imap は、IMAP\Connection
クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、リソース が期待されていました。
|
例1 imap_ping() の例
<?php
$imap = imap_open("{imap.example.org}", "mailadmin", "password");
// しばらく休んだ後
if (!imap_ping($imap)) {
// 再接続の処理
}
?>