imap_close

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

imap_close — Close an IMAP stream

Description

imap_close ( resource $imap , int $flags = 0 ) : bool

Closes the imap stream.

Parameters

imap

An IMAP stream returned by imap_open().

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()

Return Values

Returns true on success or false on failure.

See Also