Share this page

# imap_get_attribute_int

Internet Messaging Functions (IMAP)

Obtains a IMAP session attribute.

    int imap_get_attribute_int( char *property );

attribute | The IMAP attribute to retrieve. The available attributes are: `RECENT_MESSAGE_COUNT - Returns the number of recent messages in selected mailbox` `TOTAL_MESSAGE_COUNT - Total number of messages in selected mailbox` `UNSEEN_MESSAGE_COUNT - Total number of unseen message in selected mailbox` `READ_WRITE_MODE - Mode of selected mailbox.``NEXT_MESSAGE_UID - Next valid UID in selected mailbox` `MAILBOX_UID - Mailbox Identifier`

The imap_get_attribute_int function returns the value of an IMAP session attribute as an integer.

This function is for use with global sessions. For multiple sessions, use the imap_get_attribute_int_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_get_attribute_int function retrieves an IMAP session attribute.

Copy code

    // Get the Message identifier of current email message.

        int msgid = imap_get_attribute_int("Message ID");

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: