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

# imap_ping

(PHP 4, PHP 5, PHP 7)

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

### 説明

imap_ping ( resource `$imap_stream` ) : bool

imap_ping() はストリームに ping を行い、 まだアクティブであるかどうかを調べます。これにより新しいメールの到着を知ることもあります。 これは、定期的に「メールのチェック」を行い、サーバーとの 「接続を保持し続ける」ためのお勧めの方法です。

### パラメータ

`imap_stream`

  imap_open() が返す IMAP ストリーム。

### 返り値

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

### 例

例1 imap_ping() の例

`<?php
$imap = imap_open("{imap.example.org}", "mailadmin", "password");
// しばらく休んだ後
if (!imap_ping($imap)) {
// 再接続の処理
}
?>`