imap_gc

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

imap_gcLeert den IMAP-Cache

Beschreibung

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

Säubert den Cache von Einträgen eines bestimmtes Typs.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

flags

Der zu löschende Cache. Es kann eine oder eine Kombination der folgenden Konstanten sein: IMAP_GC_ELT (Cache-Elemente der Nachricht), IMAP_GC_ENV (Umschlag und Textkörper) und IMAP_GC_TEXTS (Texte).

Rückgabewerte

Gibt immer true zurück.

Fehler/Exceptions

Wenn flags ungültig ist, wird ein ValueError geworfen.

Changelog

VersionBeschreibung
8.1.0 Der Parameter imap erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige imap-Ressource erwartet.
8.0.0 Bei ungültigen Parameterwerten von flags wird nun ein ValueError geworfen; zuvor wurde eine Warnung ausgegeben und die Funktion gab false zurück.

Beispiele

Beispiel #1 imap_gc()-Beispiel

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>
To Top