Share this page

# imap_examine

Internet Messaging Functions (IMAP)

Selects a mailbox for viewing.

    int imap_examine( char *transaction, char *mailbox, LAST );

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_examine function selects a mailbox to view its messages. Calling this function does not modify the mailbox state (the number of messages unread, total number of messages, etc.).

This function is identical to imap_select, except that it only has read-access on the mailbox—it does not change any mailbox states. To retrieve the mailbox properties, call imap_get_attribute_int.

This function is for use with global sessions. For multiple sessions, use the imap_select_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_examine function chooses the Sent Mail mailbox.

Copy code

        imap_examine("ExamineSentMail",
                "Mailbox=Sent Mail",
                LAST );

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: