imap_gc

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

imap_gcClears IMAP cache

说明

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

Purges the cache of entries of a specific type.

参数

imap

IMAP\Connection 实例。

flags

Specifies the cache to purge. It may one or a combination of the following constants: IMAP_GC_ELT (message cache elements), IMAP_GC_ENV (envelope and bodies), IMAP_GC_TEXTS (texts).

返回值

总是返回 true

错误/异常

Throws a ValueError if flags is invalid.

更新日志

版本 说明
8.1.0 现在 imap 参数接受 IMAP\Connection 实例,之前接受有效的 imap resource
8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

示例

示例 #1 imap_gc() example

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>

add a note add a note

User Contributed Notes 1 note

up
2
Anonymous
15 years ago
If you notice that you're program's memory usage is increasing (as observed using ps) while calling the imap functions, calling this function should free that memory.
To Top