imap_close()

imap_close - Close an IMAP stream

Syntax

bool imap_close (resource $imap_stream, int $flag)

Arguments

• imap_stream - An IMAP stream returned by imap_open().
• flag - 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()

Description

Closes the imap stream.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.