Php/docs/function.imap-renamemailbox

• PHP Manual
• IMAP 函数
• Rename an old mailbox to new mailbox

imap_renamemailbox

(PHP 4, PHP 5, PHP 7)

imap_renamemailbox — Rename an old mailbox to new mailbox

说明

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

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

参数

imap_stream

由 imap_open() 返回的 IMAP 流。

old_mbox

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.

new_mbox

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。

参见

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