imap_renamemailbox
(PHP 4, PHP 5, PHP 7)
imap_renamemailbox — Rename an old mailbox to new mailbox
Description
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).
Parameters
-
imap_stream -
An IMAP stream returned by imap_open().
-
old_mbox -
The old mailbox name, see imap_open() for more information
WarningPassing 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
WarningPassing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
Return Values
Returns true on success or false on failure.
See Also
- imap_createmailbox() - Create a new mailbox
- imap_deletemailbox() - Delete a mailbox
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.imap-renamemailbox.php