imap_gc

(PHP 5 >= 5.3.0, PHP 7)

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

説明

imap_gc ( resource $imap_stream , int $caches ) : bool

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

パラメータ

imap_stream

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

caches

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

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例

例1 imap_gc() の例

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>