imap_gc

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

imap_gc — IMAP キャッシュをクリアする

imap_gc(IMAP\Connection $imap, int $flags): bool

指定した型のエントリのキャッシュを破棄します。

imap: IMAP\Connection クラスのインスタンス。
flags: 破棄したいキャッシュを指定します。以下の定数 IMAP_GC_ELT (メッセージキャッシュ要素)、 IMAP_GC_ENV (エンベロープおよびボディ)、 IMAP_GC_TEXTS (テキスト) の組み合わせとなります。

成功した場合に true を、失敗した場合に false を返します。

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

例1 imap_gc() の例


<?php

$mbox = imap_open("{imap.example.org:143}", "username", "password");

imap_gc($mbox, IMAP_GC_ELT);

?>