imap_renamemailbox

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

imap_renamemailbox — Ändert den Namen eines Postfachs

Beschreibung

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

Diese Funktion ändert den Namen des Postfachs von from in to (siehe imap_open() für das Format von mbox-Namen).

Parameter-Liste

imap: Eine IMAP\Connection-Instanz.
from: Der bisherige Name des Postfachs, siehe imap_open() für weitere Informationen.

Warnung
Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher,falls imap.enable_insecure_rsh nicht deaktiviert ist.
to: Der neue Name des Postfachs, siehe imap_open() für weitere Informationen.

Warnung
Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher,falls imap.enable_insecure_rsh nicht deaktiviert ist.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Changelog

Version	Beschreibung
8.1.0	Der Parameter `imap` erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige `imap`-Ressource erwartet.

Siehe auch

imap_createmailbox() - Legt ein neues Postfach an
imap_deletemailbox() - Löscht ein Postfach

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