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