4D Doc Center : IMAP

Home

4D Internet Commands v14

IMAP_RenameMB


IMAP_RenameMB ( imap_ID ; mbName ; newMBName ) -> Function result

Parameter	Type	Description
imap_ID	Longint	Reference to an IMAP login
mbName	Text	Name of the mailbox to be renamed
newMBName	Text	New mailbox name
Function result	Integer	Error code

Description

The IMAP_RenameMB command changes the name of a mailbox. Attempting to rename a mailbox from a mailbox name that does not exist or to a mailbox name that already exists will generate an error.

Note: Renaming an INBOX is permitted and involves special behavior. It moves all messages in the INBOX to a new mailbox with the given name, leaving the INBOX empty. If the server implementation allows child names for the INBOX, these are unaffected by its renaming.

imap_ID is a long integer reference to an open connection created with IMAP_Login.

mbName is the full name of the mailbox to be renamed (see naming rules in the IMAP introduction).

newMBName is the full name to apply to rename the mbName mailbox.