imap_gc

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

imap_gcLimpa o cache IMAP

Descrição

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

Limpa o cache de entradas de um tipo específico.

Parâmetros

imap

Uma instância de IMAP\Connection.

flags

Especifica o cache a ser purgado. Pode ser uma ou mais das seguintes constantes combinadas: IMAP_GC_ELT (elementos de cache de mensagens), IMAP_GC_ENV (envelope e corpos), IMAP_GC_TEXTS (textos).

Valor Retornado

Sempre retorna true.

Erros/Exceções

Lança um ValueError se flags for inválido.

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 Um ValueError agora é lançado em valores de parâmetro flags inválidos. Anteriormente, um aviso era emitido e a função retornava false.

Exemplos

Exemplo #1 Exemplo de imap_gc()

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>