imap_renamemailbox

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

imap_renamemailbox — Rename an old mailbox to new mailbox

说明

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

This function renames on old mailbox to new mailbox (see imap_open() for the format of mbox names).

参数

imap: An IMAP\Connection instance.
from: The old mailbox name, see imap_open() for more information

Warning
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
to: The new mailbox name, see imap_open() for more information

Warning
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

返回值

成功时返回 true，或者在失败时返回 false。

更新日志

版本	说明
8.1.0	The `imap` parameter expects an IMAP\Connection instance now; previously, a 资源(resource) was expected.

参见

imap_createmailbox() - Create a new mailbox
imap_deletemailbox() - Delete a mailbox

User Contributed Notes

Christoffer Lindahl 12-Oct-2010 10:27


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);


?>

josh at paducahwebpublishing dot com 03-Mar-2000 12:13


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.