imap_unsubscribe

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

imap_unsubscribe — メールボックスの購読をやめる

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

指定されたメールボックス mailbox の購読を中止します。

imap: IMAP\Connection クラスのインスタンス。
mailbox: メールボックス名。詳細は imap_open() を参照ください。

警告
信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。

成功した場合に true を、失敗した場合に false を返します。

バージョン	説明
8.1.0	引数 `imap` は、IMAP\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、リソースが期待されていました。