pstsdk::recipient Class Reference

A recipient of a message. More...

#include <message.h>

Collaboration diagram for pstsdk::recipient:

Public Member Functions
std::wstring	get_name () const
	Get the display name of this recipient.
recipient_type	get_type () const
	Get the type of this recipient.
std::wstring	get_address_type () const
	Get the address type of the recipient.
std::wstring	get_email_address () const
	Get the email address of the recipient.
bool	has_email_address () const
	Checks to see if this recipient has an email address.
std::wstring	get_account_name () const
	Get the name of the recipients account.
bool	has_account_name () const
	Checks to see if this recipient has an account name.
const_table_row &	get_property_row ()
	Get the property row underying this recipient object.
const const_table_row &	get_property_row () const
	Get the property row underying this recipient object.

Friends
struct	recipient_transform

Detailed Description

A recipient of a message.

A friendly wrapper around a recipient table row.

Definition at line 157 of file message.h.

Member Function Documentation

get_account_name()

std::wstring pstsdk::recipient::get_account_name ( ) const

inline

Get the name of the recipients account.

Returns

The account name

Definition at line 183 of file message.h.

get_address_type()

std::wstring pstsdk::recipient::get_address_type ( ) const

inline

Get the address type of the recipient.

Returns

The address type

Definition at line 171 of file message.h.

get_email_address()

std::wstring pstsdk::recipient::get_email_address ( ) const

inline

Get the email address of the recipient.

Returns

The email address

Definition at line 175 of file message.h.

get_name()

std::wstring pstsdk::recipient::get_name ( ) const

inline

Get the display name of this recipient.

Returns

The recipient name

Definition at line 163 of file message.h.

get_property_row() [1/2]

const_table_row & pstsdk::recipient::get_property_row ( )

inline

Get the property row underying this recipient object.

Returns

The property row

Definition at line 193 of file message.h.

get_property_row() [2/2]

const const_table_row & pstsdk::recipient::get_property_row ( ) const

inline

Get the property row underying this recipient object.

Returns

The property row

Definition at line 196 of file message.h.

get_type()

recipient_type pstsdk::recipient::get_type ( ) const

inline

Get the type of this recipient.

Returns

The recipient type

Definition at line 167 of file message.h.

has_account_name()

bool pstsdk::recipient::has_account_name ( ) const

inline

Checks to see if this recipient has an account name.

Returns

true if get_account_name() doesn't throw

Definition at line 187 of file message.h.

has_email_address()

bool pstsdk::recipient::has_email_address ( ) const

inline

Checks to see if this recipient has an email address.

Returns

true if get_email_address() doesn't throw

Definition at line 179 of file message.h.

Friends And Related Symbol Documentation

recipient_transform

friend struct recipient_transform

friend

Definition at line 201 of file message.h.

---

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

• pstsdk/pst/message.h