imap_gc

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

imap_gcBorra la caché IMAP

Descripción

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

Elimina todas las entradas de un tipo dado en la caché IMAP.

Parámetros

imap

Una instancia de IMAP\Connection.

flags

Indica el tipo de caché a purgar. Puede ser una combinación de las siguientes constantes: IMAP_GC_ELT (caché de los elementos de mensaje), IMAP_GC_ENV (sobre y cuerpo), IMAP_GC_TEXTS (textos).

Valores devueltos

Retorna siempre true.

Errores/Excepciones

Lanza una excepción ValueError si el argumento flags es inválido.

Historial de cambios

Versión Descripción
8.1.0 El parámetro imap ahora espera una instancia de IMAP\Connection; anteriormente, se esperaba un resource imap válido.
8.0.0 Una excepción ValueError es ahora lanzada para valores de argumento flags inválidos. Anteriormente, se emitía una advertencia y la función devolvía false.

Ejemplos

Ejemplo #1 Ejemplo conimap_gc()

<?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
2
Anonymous
16 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