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

Увага
Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.
to: The new mailbox name, see imap_open() for more information

Увага
Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.

Значення, що повертаються

Повертає true у разі успіху або false в разі помилки.

Журнал змін

Версія	Опис
8.1.0	Тепер параметр `imap` має бути примірником IMAP\Connection; раніше очікувався дійсний resource `imap`.

Прогляньте також

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

Found A Problem?

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

＋add a note

User Contributed Notes 2 notes

down

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.

down

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