« imap_delete
imap_errors »

imap_deletemailbox

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

imap_deletemailbox — メールボックスを削除する

説明

function imap_deletemailbox(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 クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap resource が期待されていました。

参考

関連キーワード:
imap   メールボックス   deletemailbox   Connection   mailbox   インスタンス   期待   delete   errors   詳細   信頼   enable   insecure   無効   危険   成功   履歴   resource   参考   createmailbox   renamemailbox   mbox   書式   ストリーム   オープン
関連する関数・ページ:
function.imap-renamemailbox   function.imap-setacl   function.imap-num-msg   function.imap-num-recent   function.imap-subscribe   function.imap-unsubscribe