Share this page

# imap_custom_request

Internet Messaging Functions (IMAP)

Executes a custom IMAP request.

    int imap_custom_request( char *transaction, char *operation, char *arguments);

transaction | A 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 function executes a custom IMAP request. 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 global sessions. For multiple sessions, use the imap_custom_request_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_custom_request function submits a request titled XPIG-LATIN. This operation does not require additional arguments.

Copy code

        imap_custom_request("CustomRequest",
                "XPIG-LATIN", "");

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: