libmapipp::message Class Reference

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

#include <message.h>

Inheritance diagram for libmapipp::message:
libmapipp::object

List of all members.

Public Types

typedef std::vector
< attachment_shared_ptr
attachment_container_type
typedef boost::shared_ptr
< attachment
attachment_shared_ptr

Public Member Functions

attachment_container_type fetch_attachments ()
 Fetches all attachments in this message.
mapi_id_t get_folder_id () const
 Get this message's parent folder ID.
mapi_id_t get_id () const
 Get this message's ID.
 message (session &mapi_session, const mapi_id_t folder_id, const mapi_id_t message_id) throw (mapi_exception)
 Constructor.
virtual ~message () throw ()
 Destructor.

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.

Examples:
attach_test.cpp.

Member Typedef Documentation


Constructor & Destructor Documentation

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_sessionThe session to use to retrieve this message.
folder_idThe id of the folder this message belongs to.
message_idThe message id.

References libmapipp::object::m_object.

virtual libmapipp::message::~message ( ) throw () [inline, virtual]

Destructor.


Member Function Documentation

Fetches all attachments in this message.

Returns:
A container of attachment shared pointers.
Examples:
attach_test.cpp.
mapi_id_t libmapipp::message::get_folder_id ( ) const [inline]

Get this message's parent folder 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:

Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/