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

imap_close

Example: imap_close Internet Messaging Functions (IMAP)

Closes a mailbox.

int imap_close( 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, "".

The imap_close function permanently removes from the current mailbox, all messages that have the \Deleted flag set. It returns the message from the selected state to the authenticated state. The currently selected mailbox is closed.

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