imap_gc
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
imap_gc — IMAP キャッシュをクリアする
パラメータ
imap
IMAP\Connection クラスのインスタンス。
flags
-
破棄したいキャッシュを指定します。以下の定数
IMAP_GC_ELT
(メッセージキャッシュ要素)、IMAP_GC_ENV
(エンベロープおよびボディ)、IMAP_GC_TEXTS
(テキスト) の組み合わせとなります。
戻り値
常に true
を返します。
エラー / 例外
flags
が無効な場合、
ValueError がスローされます。
変更履歴
バージョン | 説明 |
---|---|
8.1.0 |
引数 imap は、IMAP\Connection
クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、有効な imap リソース が期待されていました。
|
8.0.0 |
flags が無効な値の場合、
ValueError がスローされるようになりました。
これより前のバージョンでは、
警告が発生し、false を返していました。
|
例
例1 imap_gc() の例
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");
imap_gc($mbox, IMAP_GC_ELT);
?>
+add a note