imap_ping

(PHP 3, PHP 4, PHP 5)

imap_ping -- IMAP ストリームがアクティブかどうかを調べる

説明

bool imap_ping ( resource imap_stream )

ストリームがまだ有効であれば TRUE を、そうでなければ FALSE を返します。

imap_ping() 関数は、ストリームに ping を行い、 まだ有効であるかどうかをチェックします。これにより新しいメールの到着を 知る場合もあります。これは、有効時間のタイムアウトが設定してある サーバに対して "接続を持続させる" ことに加え、定期的な "新着メールのチェック" としてもよい方法です。

例 1. imap_ping() の例

<?php

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

// しばらく休んだ後
if (!imap_ping($imap)) {
    
// 再接続の処理
}

?>