Internet Messaging Functions (IMAP) > Alphabetical List of Functions > imap_delete

imap_delete

Example: imap_delete Internet Messaging Functions (IMAP)

Deletes a mailbox.

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

The imap_delete function deletes an existing mailbox.

This function is for use with global sessions. For multiple sessions, use the imap_delete_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.