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

    参考

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    3
    josh at paducahwebpublishing dot com
    24 years ago
    Don't let "...string old_mbox, string new_mbox);" fool you. You have to add the server and port to the mailbox name also. So it would be something like:

    imap_renamemailbox($mailbox, "{localhost:143}$oldfolder", "{localhost:143}$newfolder")

    Just thought I would point it out, it took me a while to figure it out.
    up
    1
    Christoffer Lindahl
    14 years ago
    Don't forget that you can't be connected to the mailbox that you are going to rename (or delete).

    If you have the following mailboxes:
    INBOX
    INBOX.Foo

    ...and want to rename "INBOX.Foo" to "INBOX.Bar" you have to be connected to "INBOX":

    <?php
    $mbox     = imap_open('{imap.example.com}INBOX', 'username', 'password');
    imap_renamemailbox($mbox, '{imap.example.com}INBOX.Foo', '{imap.example.com}INBOX.Bar');
    imap_close($mbox);
    ?>
    ＋add a note
    To Top