W3cubDocs

/PHP

imap_deletemailbox

(PHP 4, PHP 5, PHP 7)

imap_deletemailbox — Delete a mailbox

Description

imap_deletemailbox ( resource $imap_stream , string $mailbox ) : bool

Deletes the specified mailbox.

Parameters

imap_stream: An IMAP stream returned by imap_open().
mailbox: The mailbox name, see imap_open() for more information

Warning
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

Return Values

Returns true on success or false on failure.

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

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.imap-deletemailbox.php