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: IMAP\Connection 实例。
from: The old mailbox name, see imap_open() for more information

警告
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

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

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

版本	说明
8.1.0	现在 `imap` 参数接受 IMAP\Connection 实例，之前接受有效的 `imap` resource。