PHP 8.3.4 Released!

imap_ping

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

imap_ping(IMAP\Connection $imap): bool

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

パラメータ

imap

IMAP\Connection クラスのインスタンス。

戻り値

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

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap リソース が期待されていました。

例1 imap_ping() の例

<?php

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

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

?>

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top