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

imap_subscribe_ex

Example: imap_subscribe_ex Internet Messaging Functions (IMAP)

Subscribes to a mailbox for a specific IMAP session.

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

The imap_subscribe_ex function sets the specified mailbox to subscribed or active. To retrieve a list of the mailboxes that have subscriptions, call imap_list_subscriptions_ex.

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