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

imap_list_subscriptions

Example: imap_list_subscriptions Internet Messaging Functions (IMAP)

Lists the mailboxes in a subscribed or active state.

int imap_list_subscriptions( char *transaction, char *reference, char *name, LAST );
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 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 global sessions. For multiple sessions, use the imap_list_subscriptions_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.