#include <libmapi/libmapi.h>
Functions | |
_PUBLIC_ enum MAPISTATUS | CopyFolder (mapi_object_t *obj_folder, mapi_object_t *obj_src, mapi_object_t *obj_dst, char *NewFolderName, bool UseUnicode, bool WantRecursive) |
_PUBLIC_ enum MAPISTATUS | CreateFolder (mapi_object_t *obj_parent, uint8_t ulFolderType, const char *name, const char *comment, uint32_t ulFlags, mapi_object_t *obj_child) |
_PUBLIC_ enum MAPISTATUS | CreateMessage (mapi_object_t *obj_folder, mapi_object_t *obj_message) |
_PUBLIC_ enum MAPISTATUS | DeleteFolder (mapi_object_t *obj_parent, mapi_id_t FolderId, uint8_t DeleteFolderFlags, bool *PartialCompletion) |
_PUBLIC_ enum MAPISTATUS | DeleteMessage (mapi_object_t *obj_folder, mapi_id_t *id_messages, uint32_t cn_messages) |
_PUBLIC_ enum MAPISTATUS | EmptyFolder (mapi_object_t *obj_folder) |
_PUBLIC_ enum MAPISTATUS | GetMessageStatus (mapi_object_t *obj_folder, mapi_id_t msgid, uint32_t *ulStatus) |
_PUBLIC_ enum MAPISTATUS | MoveCopyMessages (mapi_object_t *obj_src, mapi_object_t *obj_dst, mapi_id_array_t *message_id, bool WantCopy) |
_PUBLIC_ enum MAPISTATUS | MoveFolder (mapi_object_t *obj_folder, mapi_object_t *obj_src, mapi_object_t *obj_dst, char *NewFolderName, bool UseUnicode) |
_PUBLIC_ enum MAPISTATUS | SetMessageStatus (mapi_object_t *obj_folder, mapi_id_t msgid, uint32_t ulNewStatus, uint32_t ulNewStatusMask, uint32_t *ulOldStatus) |
_PUBLIC_ enum MAPISTATUS | SetReadFlags (mapi_object_t *obj_folder, uint8_t ReadFlags, uint16_t MessageIdCount, uint64_t *MessageIds) |
_PUBLIC_ enum MAPISTATUS CopyFolder | ( | mapi_object_t * | obj_folder, | |
mapi_object_t * | obj_src, | |||
mapi_object_t * | obj_dst, | |||
char * | NewFolderName, | |||
bool | UseUnicode, | |||
bool | WantRecursive | |||
) |
Copy a folder
obj_folder | the folder to copy | |
obj_src | source object where the folder to copy is stored | |
obj_dst | destination object where the folder will be copied | |
NewFolderName | the new folder name in the destination folder | |
UseUnicode | whether the folder name is unicode encoded or not | |
WantRecursive | whether we should copy folder's subdirectories or not |
References emsmdb_transaction(), mapi_object_get_handle(), mapi_object_get_id(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS CreateFolder | ( | mapi_object_t * | obj_parent, | |
uint8_t | ulFolderType, | |||
const char * | name, | |||
const char * | comment, | |||
uint32_t | ulFlags, | |||
mapi_object_t * | obj_child | |||
) |
Create a folder
The function creates a folder (defined with its name, comment and type) within a specified folder.
obj_parent | the folder to create the new folder in | |
ulFolderType | the type of the folder | |
name | the name of the new folder | |
comment | the comment associated with the new folder | |
ulFlags | flags associated with folder creation | |
obj_child | pointer to the newly created folder |
ulFolderType possible values:
References emsmdb_transaction(), mapi_object_get_handle(), mapi_object_get_session(), mapi_object_init(), mapi_object_set_handle(), mapi_object_set_id(), and mapi_object_set_session().
_PUBLIC_ enum MAPISTATUS CreateMessage | ( | mapi_object_t * | obj_folder, | |
mapi_object_t * | obj_message | |||
) |
The function creates a message in the specified folder, and returns a pointer on this message.
obj_folder | the folder to create the message in. | |
obj_message | pointer to the newly created message. |
References emsmdb_transaction(), mapi_object_get_handle(), mapi_object_get_id(), mapi_object_get_session(), mapi_object_set_handle(), and mapi_object_set_session().
_PUBLIC_ enum MAPISTATUS DeleteFolder | ( | mapi_object_t * | obj_parent, | |
mapi_id_t | FolderId, | |||
uint8_t | DeleteFolderFlags, | |||
bool * | PartialCompletion | |||
) |
Delete a folder
The function deletes a specified folder.
obj_parent | the folder containing the folder to be deleted | |
FolderId | the ID of the folder to delete | |
DeleteFolderFlags | control DeleteFolder operation behavior | |
PartialCompletion | pointer on a boolean value which specify whether the operation was partially completed or not |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS DeleteMessage | ( | mapi_object_t * | obj_folder, | |
mapi_id_t * | id_messages, | |||
uint32_t | cn_messages | |||
) |
Delete one or more messages
This function deletes one or more messages based on their ids from a specified folder.
obj_folder | the folder to delete messages from | |
id_messages | the list of ids | |
cn_messages | the number of messages in the id list. |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS EmptyFolder | ( | mapi_object_t * | obj_folder | ) |
Empty the contents of a folder
This function empties (clears) the contents of a specified folder.
obj_folder | the folder to empty |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS GetMessageStatus | ( | mapi_object_t * | obj_folder, | |
mapi_id_t | msgid, | |||
uint32_t * | ulStatus | |||
) |
Obtain the status associated with a message
This function obtains the status associated with a message in the given folder.
obj_folder | the folder where the message is located | |
msgid | the message ID | |
ulStatus | the message status |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS MoveCopyMessages | ( | mapi_object_t * | obj_src, | |
mapi_object_t * | obj_dst, | |||
mapi_id_array_t * | message_id, | |||
bool | WantCopy | |||
) |
Copy or Move a message from a folder to another
obj_src | The source folder | |
obj_dst | The destination folder | |
message_id | pointer to container object for message ids. | |
WantCopy | boolean value, defines whether the operation is a copy or a move |
References emsmdb_transaction(), mapi_id_array_get(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS MoveFolder | ( | mapi_object_t * | obj_folder, | |
mapi_object_t * | obj_src, | |||
mapi_object_t * | obj_dst, | |||
char * | NewFolderName, | |||
bool | UseUnicode | |||
) |
Moves a folder
obj_folder | the folder to move | |
obj_src | source object where the folder to move is stored | |
obj_dst | destination object where the folder will be moved | |
NewFolderName | the new folder name in the destination folder | |
UseUnicode | whether the folder name is unicode encoded or not |
References emsmdb_transaction(), mapi_object_get_handle(), mapi_object_get_id(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS SetMessageStatus | ( | mapi_object_t * | obj_folder, | |
mapi_id_t | msgid, | |||
uint32_t | ulNewStatus, | |||
uint32_t | ulNewStatusMask, | |||
uint32_t * | ulOldStatus | |||
) |
Set the status associated with a message
This function sets the status associated with a message in the given folder.
obj_folder | the folder where the message is located | |
msgid | the message ID | |
ulNewStatus | the new status to be assigned | |
ulNewStatusMask | bitmask of flags hat is applied to the new status indicating the flags to be set | |
ulOldStatus | pointer on the previous status of the message |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
_PUBLIC_ enum MAPISTATUS SetReadFlags | ( | mapi_object_t * | obj_folder, | |
uint8_t | ReadFlags, | |||
uint16_t | MessageIdCount, | |||
uint64_t * | MessageIds | |||
) |
Set the Read Flags on one or more messages
obj_folder | the folder containing the messages to change | |
ReadFlags | a bitmap of flags controlling the changes to PR_PROPERTY_FLAGS | |
MessageIdCount | the number of messages in the MessageIds array | |
MessageIds | an array of message ids to set Read flags for |
References emsmdb_transaction(), mapi_object_get_handle(), and mapi_object_get_session().
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |