IMAP Functions
PHP Manual

imap_deletemailbox

Delete a mailbox

Description

bool imap_deletemailbox(IMAP\Connection $imap, string $mailbox)

Deletes the specified mailbox.

Parameters

imap

An IMAP\Connection instance.

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.

Changelog

Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

See Also

  • imap_createmailbox
  • imap_renamemailbox
  • imap_open for the format of mbox