imap_close

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_closeSchließt einen IMAP-Stream

Beschreibung

imap_close(IMAP\Connection $imap, int $flags = 0): true

Schließt den angegebenen IMAP-Stream.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

flags

Wenn CL_EXPUNGE als flag übergeben wird, werden alle zum Löschen vorgemerkten Nachrichten des aktuellen Postfachs vor Beenden der Verbindung endgültig gelöscht. Dies lässt sich auch durch die Funktion imap_expunge() erreichen.

Rückgabewerte

Gibt immer true zurück.

Fehler/Exceptions

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

Changelog

Version Beschreibung
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.

Siehe auch

  • imap_open() - Öffnet einen IMAP-Stream zu einem Postfach

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top