imap_deletemailbox
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_deletemailbox — Delete a mailbox
Description
Deletes the specified mailbox
.
Parameters
-
imap
-
An IMAP\Connection instance.
-
mailbox
-
The mailbox name, see imap_open() for more information
WarningPassing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
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.
|
See Also
- imap_createmailbox() - Create a new mailbox
- imap_renamemailbox() - Rename an old mailbox to new mailbox
-
imap_open() - Open an IMAP stream to a mailbox for the format of
mbox