Fairport
v1.0.38
|
Represents a message in a PST file. More...
#include <message.h>
Public Types | |
typedef boost::transform_iterator < attachment_transform, const_table_row_iter > | attachment_iterator |
Attachment iterator type; a transform iterator over a table row iterator. | |
typedef boost::transform_iterator < recipient_transform, const_table_row_iter > | recipient_iterator |
Recipient iterator type; a transform iterator over a table row iterator. | |
Public Member Functions | |
message (const node &n) | |
Construct a message object. | |
message (const message &other) | |
attachment_iterator | attachment_begin () const |
Get an iterator to the first message on this message. | |
attachment_iterator | attachment_end () const |
Get the end attachment iterator. | |
recipient_iterator | recipient_begin () const |
Get an iterator to the first recipient of this message. | |
recipient_iterator | recipient_end () const |
Get the end recipient iterator. | |
std::wstring | get_subject () const |
Get the subject of this message. | |
bool | has_subject () const |
Check to see if a subject is set on this message. | |
std::wstring | get_body () const |
Get the body of this message. | |
hnid_stream_device | open_body_stream () |
Get the body of this message. | |
size_t | body_size () const |
Size of the body, in bytes. | |
bool | has_body () const |
Checks to see if this message has a body. | |
std::wstring | get_html_body () const |
Get the HTML body of this message. | |
hnid_stream_device | open_html_body_stream () |
Get the HTML body of this message. | |
size_t | html_body_size () const |
Size of the HTML body, in bytes. | |
bool | has_html_body () const |
Checks to see if this message has a HTML body. | |
size_t | size () const |
size_t | get_attachment_count () const |
Get the number of attachments on this message. | |
boost::posix_time::ptime | get_delivery_time () const |
Get the delivery time of this message. | |
boost::posix_time::ptime | get_last_modification_time () const |
Get the last modification time of this message. | |
size_t | get_recipient_count () const |
Get the number of recipients on this message. | |
table & | get_attachment_table () |
Get the attachment table of this message. | |
table & | get_recipient_table () |
Get the recipient table of this message. | |
const table & | get_attachment_table () const |
const table & | get_recipient_table () const |
Represents a message in a PST file.
A message is the basic abstraction exposed by MAPI - everything is a message; a mail item, a calendar item, a contact, etc.
This class exposes some common properties on messages as well as iteration mechanisms to get to the attachments and recipients on the message. You will most likely find it necessary to get the underylying property bag and look up specific properties not exposed here.
typedef boost::transform_iterator<attachment_transform, const_table_row_iter> fairport::message::attachment_iterator |
typedef boost::transform_iterator<recipient_transform, const_table_row_iter> fairport::message::recipient_iterator |
fairport::message::message | ( | const node & | n | ) | [inline, explicit] |
fairport::message::message | ( | const message & | other | ) | [inline] |
attachment_iterator fairport::message::attachment_begin | ( | ) | const [inline] |
attachment_iterator fairport::message::attachment_end | ( | ) | const [inline] |
size_t fairport::message::body_size | ( | ) | const [inline] |
size_t fairport::message::get_attachment_count | ( | ) | const [inline] |
table& fairport::message::get_attachment_table | ( | ) | [inline] |
const fairport::table & fairport::message::get_attachment_table | ( | ) | const [inline] |
std::wstring fairport::message::get_body | ( | ) | const [inline] |
boost::posix_time::ptime fairport::message::get_delivery_time | ( | ) | const [inline] |
std::wstring fairport::message::get_html_body | ( | ) | const [inline] |
boost::posix_time::ptime fairport::message::get_last_modification_time | ( | ) | const [inline] |
size_t fairport::message::get_recipient_count | ( | ) | const [inline] |
table& fairport::message::get_recipient_table | ( | ) | [inline] |
const fairport::table & fairport::message::get_recipient_table | ( | ) | const [inline] |
std::wstring fairport::message::get_subject | ( | ) | const [inline] |
bool fairport::message::has_body | ( | ) | const [inline] |
bool fairport::message::has_html_body | ( | ) | const [inline] |
bool fairport::message::has_subject | ( | ) | const [inline] |
size_t fairport::message::html_body_size | ( | ) | const [inline] |
hnid_stream_device fairport::message::open_body_stream | ( | ) | [inline] |
Get the body of this message.
The returned stream device can be used to construct a proper stream:
message m = ...; prop_stream body(a.open_body_stream());
Which can then be used as any iostream would be.
hnid_stream_device fairport::message::open_html_body_stream | ( | ) | [inline] |
Get the HTML body of this message.
The returned stream device can be used to construct a proper stream:
message m = ...; prop_stream htmlbody(a.open_html_body_stream());
Which can then be used as any iostream would be.
recipient_iterator fairport::message::recipient_begin | ( | ) | const [inline] |
recipient_iterator fairport::message::recipient_end | ( | ) | const [inline] |
size_t fairport::message::size | ( | ) | const [inline] |