Check if the IMAP stream is still active

# imap_ping

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

imap_ping — Check if the IMAP stream is still active

### 说明

function imap_ping(IMAP\Connection `$imap`): bool

imap_ping() pings the stream to see if it's still active. It may discover new mail; this is the preferred method for a periodic "new mail check" as well as a "keep alive" for servers which have inactivity timeout.

### 参数

`imap`
  IMAP\Connection 实例。

### 返回值

Returns `true` if the stream is still alive, `false` otherwise.

### 更新日志

版本 | 说明
--- | ---
8.1.0 | 现在 `imap` 参数接受 IMAP\Connection 实例，之前接受有效的 `imap` resource。

### 示例

示例 #1 imap_ping() Example

    <?php

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

    // after some sleeping
    if (!imap_ping($imap)) {
        // do some stuff to reconnect
    }

    ?>

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open