Php/docs/function.imap-renamemailbox

• PHP Manual
• IMAP 関数
• メールボックスの名前を変更する

imap_renamemailbox

(PHP 4, PHP 5, PHP 7)

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

説明

imap_renamemailbox ( resource $imap_stream , string $old_mbox , string $new_mbox ) : bool

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

パラメータ

imap_stream

imap_open() が返す IMAP ストリーム。

old_mbox

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

警告

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

new_mbox

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

警告

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

返り値

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

参考

• imap_createmailbox() - 新しいメールボックスを作る
• imap_deletemailbox() - メールボックスを削除する