This class represents a folder or container within Exchange. More...
#include <folder.h>
Public Types | |
typedef boost::shared_ptr< folder > | folder_shared_ptr |
Pointer to a folder. More... | |
typedef std::vector < folder_shared_ptr > | hierarchy_container_type |
Hierarchy folders. More... | |
typedef std::vector < message_shared_ptr > | message_container_type |
typedef boost::shared_ptr < message > | message_shared_ptr |
Pointer to a message. More... | |
Public Member Functions | |
void | delete_message (mapi_id_t message_id) throw (mapi_exception) |
Delete a message that belongs to this folder. More... | |
hierarchy_container_type | fetch_hierarchy () throw (mapi_exception) |
Fetch all subfolders within this folder. More... | |
message_container_type | fetch_messages () throw (mapi_exception) |
Fetch all messages in this folder. More... | |
folder (object &parent_folder, const mapi_id_t folder_id) throw (mapi_exception) | |
Constructor. More... | |
mapi_id_t | get_id () const |
Obtain folder id. More... | |
virtual | ~folder () throw () |
Destructor. More... | |
![]() | |
virtual mapi_object_t & | data () throw () |
Obtain a reference to the mapi_object_t associated with this object. More... | |
virtual property_container | get_property_container () |
Obtain a property_container to be used with this object. More... | |
virtual session & | get_session () |
Obtain the session associated with this object. More... | |
object (session &mapi_session, const std::string &object_type="") throw () | |
Object Constructor. More... | |
virtual | ~object () throw () |
Destructor. More... | |
Additional Inherited Members | |
![]() | |
mapi_object_t | m_object |
session & | m_session |
This class represents a folder or container within Exchange.
typedef boost::shared_ptr<folder> libmapipp::folder::folder_shared_ptr |
Pointer to a folder.
typedef std::vector<folder_shared_ptr> libmapipp::folder::hierarchy_container_type |
Hierarchy folders.
This is a vector (list) of child folders for a given folder
typedef std::vector<message_shared_ptr > libmapipp::folder::message_container_type |
typedef boost::shared_ptr<message> libmapipp::folder::message_shared_ptr |
Pointer to a message.
|
inline |
Constructor.
parent_folder | The parent of this folder. |
folder_id | This folder's id. |
References libmapipp::object::m_object.
|
inlinevirtual |
Destructor.
|
inline |
Delete a message that belongs to this folder.
message_id | The id of the message to delete. |
References libmapipp::object::m_object.
hierarchy_container_type libmapipp::folder::fetch_hierarchy | ( | ) | ||
throw | ( | mapi_exception | ||
) |
Fetch all subfolders within this folder.
message_container_type libmapipp::folder::fetch_messages | ( | ) | ||
throw | ( | mapi_exception | ||
) |
Fetch all messages in this folder.
|
inline |
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |