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

imap_get_attribute_int

Example: 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 mailboxTOTAL_MESSAGE_COUNT - Total number of messages in selected mailboxUNSEEN_MESSAGE_COUNT - Total number of unseen message in selected mailboxREAD_WRITE_MODE - Mode of selected mailbox.NEXT_MESSAGE_UID - Next valid UID in selected mailboxMAILBOX_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.