CascadiaPHP 2024

imap_gc

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

imap_gcОчищает кеш IMAP

Описание

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

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

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

imap

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

flags

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

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

Функция возвращает логическое значение true.

Ошибки

Выбрасывает исключение ValueError, если значение параметра flags недопустимо.

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

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.
8.0.0 Теперь выбрасывается исключение ValueError при недопустимых значениях параметра flags. Ранее возникало предупреждение и функция возвращала логическое значение false.

Примеры

Пример #1 Пример использования imap_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
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