imap_close
PHP 4, PHP 5, PHP 7, PHP 8
imap_close - Close an IMAP stream
Manual
imap_close(
IMAP\Connection$imap,
[int$flags = 0] ): bool
Closes the imap stream.
Parameters
- imap
An IMAP\Connection instance.
- 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.
Changelog
| Version | Description |
| 8.1.0 | The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected. |