4D Doc Center : IMAP

Home

4D Internet Commands v14

IMAP_CreateMB


IMAP_CreateMB ( imap_ID ; mbName ) -> Function result

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

Description

The IMAP_CreateMB command creates a mailbox with the given name. If the IMAP server’s hierarchy separator character appears elsewhere in the mailbox name, the IMAP server will create any parent names needed to create the given mailbox.

In other words, an attempt to create “Projects/IMAP/Doc” on a server in which “/” is the hierarchy separator character will create:

Only the “Doc” mailbox if “Projects” & “IMAP” already exist.
“IMAP” & “Doc” mailboxes if only “Projects” already exists.
“Projects” & “IMAP” & “Doc” mailboxes, if they do not already exist.

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 created (see naming rules in the IMAP introduction).

Note: Attempting to create an INBOX (which is a special name reserved to mean “the primary mailbox for this user on this server”) or a mailbox with a name referring to an existing mailbox will lead to an error.