Home/ Manual/ imap / functions/ imap_close

imap_close

PHP function Edit on GitHub ✎

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

Close an IMAP stream

Description

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

Closes the imap stream.

flags: If set to CL_EXPUNGE, the function will silently expunge the mailbox before closing, removing all messages marked for deletion. You can achieve the same thing by using imap_expunge()

Always

Throws a ValueError if flags is invalid.

Version	Description
8.0.0	A `ValueError` is now thrown on invalid `flags` parameter values. Previously, a warning was emitted and the function returned false.