imap_gc

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

imap_gc — Очистить кеш IMAP

Описание

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

Удаляет из кеша записи заданного типа.

Список параметров

imap

Экземпляр IMAP\Connection.

flags

Задаёт кеш для чистки. Может быть любой комбинацией констант: IMAP_GC_ELT (элементы кеша сообщений), IMAP_GC_ENV (обёртки и тела), IMAP_GC_TEXTS (тексты).

Возвращаемые значения

Возвращает true в случае успешного выполнения или false в случае возникновения ошибки.

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр IMAP\Connection; ранее ожидался ресурс (resource) imap.

Примеры

Пример #1 Пример использования imap_gc()

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>