imap_subscribe

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_subscribe — Subscribe to a mailbox

Description

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

Subscribe to a new 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

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

See Also