Convenience functions. More...
#include "libmapi/libmapi.h"#include "libmapi/libmapi_private.h"Functions | |
| _PUBLIC_ enum MAPISTATUS | AddUserPermission (mapi_object_t *obj_folder, const char *username, enum ACLRIGHTS role) |
| _PUBLIC_ enum MAPISTATUS | GetBestBody (mapi_object_t *obj_message, uint8_t *format) |
| _PUBLIC_ enum MAPISTATUS | GetDefaultFolder (mapi_object_t *obj_store, uint64_t *folder, const uint32_t id) |
| _PUBLIC_ enum MAPISTATUS | GetDefaultPublicFolder (mapi_object_t *obj_store, uint64_t *folder, const uint32_t id) |
| _PUBLIC_ enum MAPISTATUS | GetFolderItemsCount (mapi_object_t *obj_folder, uint32_t *unread, uint32_t *total) |
| _PUBLIC_ bool | IsMailboxFolder (mapi_object_t *obj_store, uint64_t fid, uint32_t *olFolder) |
| _PUBLIC_ enum MAPISTATUS | ModifyUserPermission (mapi_object_t *obj_folder, const char *username, enum ACLRIGHTS role) |
| _PUBLIC_ enum MAPISTATUS | RemoveUserPermission (mapi_object_t *obj_folder, const char *username) |
Convenience functions.
| _PUBLIC_ enum MAPISTATUS AddUserPermission | ( | mapi_object_t * | obj_folder, |
| const char * | username, | ||
| enum ACLRIGHTS | role | ||
| ) |
Adds permissions for a user on a given folder
| obj_folder | the folder we add permission for |
| username | the Exchange username we add permissions for |
| role | the permission mask value |
The following permissions and rights are supported:
References mapi_object_get_session(), MAPIFreeBuffer(), ModifyPermissions(), ResolveNames(), and set_SPropTagArray().
| _PUBLIC_ enum MAPISTATUS GetBestBody | ( | mapi_object_t * | obj_message, |
| uint8_t * | format | ||
| ) |
Implement the BestBody algorithm and return the best body content type for a given message.
| obj_message | the message we find the best body for |
| format | the format - see below. |
References GetProps(), mapi_object_get_session(), MAPIFreeBuffer(), and set_SPropTagArray().
| _PUBLIC_ enum MAPISTATUS GetDefaultFolder | ( | mapi_object_t * | obj_store, |
| uint64_t * | folder, | ||
| const uint32_t | id | ||
| ) |
Retrieves the folder id for the specified default folder in a mailbox store
| obj_store | the store to search |
| id | the type of folder to search for |
| folder | the resulting folder reference |
The following types of folders are supported:
Note that this function will cache FID values for common accessed folders such as calendar, contact, journal, note, task and drafts until the store object got released.
| _PUBLIC_ enum MAPISTATUS GetDefaultPublicFolder | ( | mapi_object_t * | obj_store, |
| uint64_t * | folder, | ||
| const uint32_t | id | ||
| ) |
Retrieve the folder id for the specified default folder in a public folder store
| obj_store | the store to search |
| id | the type of folder to search for |
| folder | the resulting folder reference |
The following types of folders are supported:
Referenced by GetUserFreeBusyData().
| _PUBLIC_ enum MAPISTATUS GetFolderItemsCount | ( | mapi_object_t * | obj_folder, |
| uint32_t * | unread, | ||
| uint32_t * | total | ||
| ) |
Retrieves the total and unread number of items for a specified folder.
| obj_folder | the folder to get item counts for |
| unread | the number of items in the folder (result) |
| total | the number of items in the folder, including unread items (result) |
References GetProps(), mapi_object_get_session(), MAPIFreeBuffer(), and set_SPropTagArray().
| _PUBLIC_ bool IsMailboxFolder | ( | mapi_object_t * | obj_store, |
| uint64_t | fid, | ||
| uint32_t * | olFolder | ||
| ) |
Check if a given folder identifier matches with a system/default one and optionally returns the olFolder type
| obj_store | pointer to the store object |
| fid | reference to the folder identifier to check |
| olFolder | pointer to the returned olFolder |
| _PUBLIC_ enum MAPISTATUS ModifyUserPermission | ( | mapi_object_t * | obj_folder, |
| const char * | username, | ||
| enum ACLRIGHTS | role | ||
| ) |
Modify permissions for a user on a given folder
| obj_folder | the folder to modify permissions for |
| username | the Exchange username to modify permissions for |
| role | the permission mask value (see AddUserPermission) |
References GetPermissionsTable(), mapi_object_get_session(), mapi_object_init(), mapi_object_release(), MAPIFreeBuffer(), ModifyPermissions(), QueryPosition(), QueryRows(), ResolveNames(), set_SPropTagArray(), and SetColumns().
| _PUBLIC_ enum MAPISTATUS RemoveUserPermission | ( | mapi_object_t * | obj_folder, |
| const char * | username | ||
| ) |
Remove permissions for a user on a given folder
| obj_folder | the folder to remove permission from |
| username | the Exchange username to remove permissions for |
References GetPermissionsTable(), mapi_object_get_session(), mapi_object_init(), mapi_object_release(), MAPIFreeBuffer(), ModifyPermissions(), QueryPosition(), QueryRows(), ResolveNames(), set_SPropTagArray(), and SetColumns().
|
|
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |