imap_unsubscribe

Internet Messaging Functions (IMAP)

Unsubscribes a mailbox.

int imap_unsubscribe( 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 a mailbox in the following format:"MAILBOX=mailbox_name"
LAST A marker indicating the end of the argument list.

The imap_unsubscribe function unsubscribes the specified mailbox. The unsubscribe command removes the specified mailbox name from the server's set of "active" or "subscribed" mailboxes.

This function is for use with global sessions. For multiple sessions, use the imap_subscribe_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_unsubscribe function unsubscribes the MyMailbox mailbox. 

    imap_unsubscribe("Subscribe",
        "Mailbox=MyMailbox",
        "Mailbox=MyMailbox/stuff",
        LAST );