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


Example: imap_list_subscriptions_ex Internet Messaging Functions (IMAP)

Lists the mailboxes in a subscribed or active state, for a specific session.

int imap_list_subscriptions_ex( IMAP *ppimap, char *transaction, char *reference, char *name, 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, "".
reference The location or path of the mailbox in the following format: Reference=reference name
name The names of the desired mailboxes. You can use wildcards, *, together with partial mailbox names. For example: "MatchName=comp.mail.*"
LAST A marker indicating the end of the argument list.

The imap_list_subscriptions_ex function lists the mailboxes that were declared as subscribed or active for the client. The reply contains the name attributes, hierarchy delimiter, and mailbox names.

This function is for use with multiple sessions. For global sessions, use the imap_list_subscriptions function, which leaves out the session identifier.

Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.


All arguments of this function of the type char, can be parameterized with standard parameterization.