imap_custom_request_ex

Internet Messaging Functions (IMAP)

Executes a custom IMAP request, for a specific session.

int imap_custom_request_ex( IMAP *ppimap, char *transaction, char *operation, char *arguments );
ppimap A session identifier.
transactionA transaction name for this step in quotes. To avoid creating a transaction for this step, use a null string, "".
operation The operation to perform.
arguments The arguments for the operation. If no arguments are required, use a null string, "".

The imap_custom_request_ex function executes a custom IMAP request, for a specific session. This function is useful for handling IMAP server-specific extensions that are not covered by the IMAP4rev1 protocol specifications.

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

Example

In the following example, the imap_custom_request_ex function submits a request titled XPIG-LATIN. This operation does not require additional arguments. 

    imap_custom_request_ex(&imap1,"CustomRequest",
            "XPIG-LATIN", "");