messageBuilder Class Reference

#include <messageBuilder.hpp>

Public Member Functions
	messageBuilder ()
	~messageBuilder ()
const mailbox &	getExpeditor () const
void	setExpeditor (const mailbox &expeditor)
const addressList &	getRecipients () const
addressList &	getRecipients ()
void	setRecipients (const addressList &recipients)
const addressList &	getCopyRecipients () const
addressList &	getCopyRecipients ()
void	setCopyRecipients (const addressList &cc)
const addressList &	getBlindCopyRecipients () const
addressList &	getBlindCopyRecipients ()
void	setBlindCopyRecipients (const addressList &bcc)
const text &	getSubject () const
void	setSubject (const text &subject)
void	attach (shared_ptr< attachment > attach)
void	appendAttachment (shared_ptr< attachment > attach)
void	removeAttachment (const size_t pos)
const shared_ptr< const attachment >	getAttachmentAt (const size_t pos) const
shared_ptr< attachment >	getAttachmentAt (const size_t pos)
size_t	getAttachmentCount () const
const std::vector< shared_ptr< const attachment > >	getAttachmentList () const
const std::vector< shared_ptr< attachment > >	getAttachmentList ()
void	constructTextPart (const mediaType &type)
shared_ptr< textPart >	getTextPart ()
shared_ptr< message >	construct () const

Detailed Description

A helper for building MIME messages.

Constructor & Destructor Documentation

messageBuilder()

messageBuilder

(

)

References messageBuilder::constructTextPart(), vmime::mediaTypes::TEXT, and vmime::mediaTypes::TEXT_PLAIN.

~messageBuilder()

~messageBuilder

(

)

Member Function Documentation

appendAttachment()

void appendAttachment

(

shared_ptr< attachment >

attach

)

Attach a new object to the message.

Parameters

attach

new attachment

References messageBuilder::attach().

Referenced by messageBuilder::attach().

attach()

void attach

(

shared_ptr< attachment >

attach

)

Attach a new object to the message.

Deprecated:

Use messageBuilder::appendAttachment() instead.

Parameters

attach

new attachment

References messageBuilder::appendAttachment(), and messageBuilder::attach().

Referenced by messageBuilder::appendAttachment(), and messageBuilder::attach().

construct()

shared_ptr< message > construct

(

)

const

Construct a new message based on the information specified in this object.

Returns

a new message

References vmime::clone(), vmime::dynamicCast(), addressList::getAddressAt(), bodyPart::getBody(), addressList::isEmpty(), mailbox::isEmpty(), vmime::mediaTypes::MULTIPART, vmime::mediaTypes::MULTIPART_ALTERNATIVE, vmime::mediaTypes::MULTIPART_MIXED, datetime::now(), and vmime::SUPPORTED_MIME_VERSION.

constructTextPart()

void constructTextPart

(

const mediaType &

type

)

Change the type of the text part and construct a new part.

Parameters

type	media type of the text part

References textPartFactory::create(), vmime::dynamicCast(), and textPartFactory::getInstance().

Referenced by messageBuilder::messageBuilder().

getAttachmentAt() [1/2]

shared_ptr< attachment > getAttachmentAt

(

const size_t

pos

)

Return the attachment at the specified position.

Parameters

pos	position of the attachment

Returns

attachment at the specified position

References vmime::dynamicCast().

getAttachmentAt() [2/2]

const shared_ptr< const attachment > getAttachmentAt

(

const size_t

pos

)

const

Return the attachment at the specified position.

Parameters

pos	position of the attachment

Returns

attachment at the specified position

References vmime::dynamicCast().

getAttachmentCount()

size_t getAttachmentCount

(

)

const

Return the number of attachments in the message.

Returns

number of attachments

getAttachmentList() [1/2]

const std::vector< shared_ptr< attachment > > getAttachmentList

(

)

Return the list of attachments.

Returns

list of attachments

getAttachmentList() [2/2]

const std::vector< shared_ptr< const attachment > > getAttachmentList

(

)

const

Return the list of attachments.

Returns

list of attachments

References vmime::dynamicCast().

getBlindCopyRecipients() [1/2]

addressList & getBlindCopyRecipients

(

)

Return the blind-copy recipients of the message (Bcc:).

Returns

blind-copy recipients of the message

getBlindCopyRecipients() [2/2]

const addressList & getBlindCopyRecipients

(

)

const

Return the blind-copy recipients of the message (Bcc:).

Returns

blind-copy recipients of the message

getCopyRecipients() [1/2]

addressList & getCopyRecipients

(

)

Return the copy recipients of the message (Cc:).

Returns

copy recipients of the message

getCopyRecipients() [2/2]

const addressList & getCopyRecipients

(

)

const

Return the copy recipients of the message (Cc:).

Returns

copy recipients of the message

getExpeditor()

const mailbox & getExpeditor

(

)

const

Return the expeditor of the message (From:).

Returns

expeditor of the message

getRecipients() [1/2]

addressList & getRecipients

(

)

Return the recipients of the message (To:).

return recipients of the message

getRecipients() [2/2]

const addressList & getRecipients

(

)

const

Return the recipients of the message (To:).

return recipients of the message

getSubject()

const text & getSubject

(

)

const

Return the subject of the message.

Returns

subject of the message

getTextPart()

shared_ptr< textPart > getTextPart

(

)

Return the text part of the message.

Returns

text part of the message

removeAttachment()

void removeAttachment

(

const size_t

pos

)

Remove the attachment at the specified position.

Parameters

pos	position of the attachment to remove

References vmime::dynamicCast().

setBlindCopyRecipients()

void setBlindCopyRecipients

(

const addressList &

bcc

)

Set the blind-copy recipients of the message (Bcc:).

Parameters

bcc	list of blind-copy recipients

References vmime::dynamicCast().

setCopyRecipients()

void setCopyRecipients

(

const addressList &

cc

)

Set the copy recipients of the message (Cc:).

Parameters

cc	list of copy recipients

References vmime::dynamicCast().

setExpeditor()

void setExpeditor

(

const mailbox &

expeditor

)

Set the expeditor of the message (From:).

Parameters

expeditor

expeditor of the message

References vmime::dynamicCast().

setRecipients()

void setRecipients

(

const addressList &

recipients

)

Set the recipients of the message (To:).

Parameters

recipients

list of recipients

References vmime::dynamicCast().

setSubject()

void setSubject

(

const text &

subject

)

Set the subject of the message.

Parameters

subject

message subject

---

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

• messageBuilder.hpp
• messageBuilder.cpp