Share this page
imap_get_attribute_sz
| Example: imap_get_attribute_sz | Internet Messaging Functions (IMAP) |
Obtains a IMAP session property.
char *imap_get_attribute_sz( char *property );
| attribute | The IMAP attribute to retrieve. There are currently no available attributes: |
The imap_get_attribute_sz function returns the value of an IMAP session attribute as a string.
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 the value of the specified property. Otherwise, it returns LR_FAIL.
Parameterization
All arguments of this function of the type char, can be parameterized with standard parameterization.
