libmapipp::message Class Reference

This class represents a message in Exchange. More...

#include <message.h>

Inheritance diagram for libmapipp::message:

Public Types
typedef std::vector< attachment_shared_ptr >	attachment_container_type
typedef std::shared_ptr< attachment >	attachment_shared_ptr

Public Member Functions
attachment_container_type	fetch_attachments ()
	Fetches all attachments in this message. More...
mapi_id_t	get_folder_id () const
	Get this message's parent folder ID. More...
mapi_id_t	get_id () const
	Get this message's ID. More...
	message (session &mapi_session, const mapi_id_t folder_id, const mapi_id_t message_id) throw (mapi_exception)
	Constructor. More...
virtual	~message () throw ()
	Destructor. More...
Public Member Functions inherited from libmapipp::object
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
Protected Attributes inherited from libmapipp::object
mapi_object_t	m_object
session &	m_session

Detailed Description

This class represents a message in Exchange.

It is important to note that a message is not necessarily an email message. It could be a contact, journal or anything else that is not a folder.

Member Typedef Documentation

attachment_container_type

typedef std::vector<attachment_shared_ptr> libmapipp::message::attachment_container_type

attachment_shared_ptr

typedef std::shared_ptr<attachment> libmapipp::message::attachment_shared_ptr

Constructor & Destructor Documentation

message()

libmapipp::message::message ( session &  mapi_session, const mapi_id_t  folder_id, const mapi_id_t  message_id  ) throw ( mapi_exception )

inline

Constructor.

Parameters

mapi_session	The session to use to retrieve this message.
folder_id	The id of the folder this message belongs to.
message_id	The message id.

References libmapipp::object::m_object.

~message()

virtual libmapipp::message::~message ( ) throw ( )

inlinevirtual

Destructor.

Member Function Documentation

fetch_attachments()

attachment_container_type libmapipp::message::fetch_attachments

(

)

Fetches all attachments in this message.

Returns

A container of attachment shared pointers.

get_folder_id()

mapi_id_t libmapipp::message::get_folder_id ( ) const

inline

Get this message's parent folder ID.

get_id()

mapi_id_t libmapipp::message::get_id ( ) const

inline

Get this message's ID.

---

The documentation for this class was generated from the following file:

• libmapi++/message.h