imap_close_ex

Example: imap_close_ex Internet Messaging Functions (IMAP)

Closes a mailbox for a specific IMAP session.

int imap_close_ex( IMAP *ppimap, char *transaction, char *mailbox, LAST );
ppimap A session identifier.
transaction A transaction name for this step in quotes. To avoid creating a transaction for this step, use a null string, "".

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

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