imap_renamemailbox

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

imap_renamemailboxメールボックスの名前を変更する

説明

imap_renamemailbox(IMAP\Connection $imap, string $from, string $to): bool

この関数は、古いメールボックスを新しいメールボックスにリネーム します(mbox 名のフォーマットについては imap_open() を参照ください)。

パラメータ

imap

IMAP\Connection クラスのインスタンス。

from

古いメールボックス名。詳細は imap_open() を参照ください。

警告

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

to

新しいメールボックス名。詳細は imap_open() を参照ください。

警告

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

戻り値

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

変更履歴

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

参考

関連キーワード:  メールボックス, 変更, 名前, renamemailbox, Connection, open, 参照, パラメータ, 期待, バージョン