imap_create

Internet Messaging Functions (IMAP)

Creates a mailbox.

int imap_create( char *transaction, char *mailbox, LAST );
transactionA transaction name for this step in quotes. To avoid creating a transaction for this step, use a null string, "".
mailboxThe name of the mailbox(es) to create."MAILBOX=mailbox1", "MAILBOX=mailbox2", ...
LAST A marker indicating the end of the argument list.

The imap_create function creates a new mailbox.

This function is for use with global sessions. For multiple sessions, use the imap_create_ex function, which allows you to specify a session identifier.

Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

Parameterization

All arguments of this function of the type char, can be parameterized with standard parameterization.

Example

In the following example, the imap_create function creates multiple mailboxes. 

    imap_create("CreateMailbox",
            "Mailbox=MyMailbox",
            LAST );
    imap_create("CreateMailboxes",
            "Mailbox=Products",
            "Mailbox=Solutions",
            "Mailbox=FAQs",
            LAST );