imap_deletemailbox

PHP 4, PHP 5, PHP 7, PHP 8
imap_deletemailbox - Delete a mailbox
Manual

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

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 resource was expected.

Related Functions

Function imap_deletemailbox:

  • Manual

IMAP, POP3 and NNTP Functions

Most used PHP functions