PHPCon Poland 2024

imap_gc

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

imap_gcClears IMAP cache

Descrição

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

Purges the cache of entries of a specific type.

Parâmetros

imap

Uma instância de 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).

Valor Retornado

Sempre retorna true.

Erros/Exceções

Throws a ValueError if flags is invalid.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resource imap válido era esperado.
8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

Exemplos

Exemplo #1 imap_gc() example

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>

add a note

User Contributed Notes 1 note

up
3
Anonymous
14 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