Mail Message Lib

Data Structures
struct	MailBox
struct	MailMessage
class	MailAttachment
Enumerations
enum	MM_MAILMIME {   MM_MAILMIME_MECHANISM_ERROR, MM_MAILMIME_MECHANISM_7BIT, MM_MAILMIME_MECHANISM_8BIT, MM_MAILMIME_MECHANISM_BINARY,   MM_MAILMIME_MECHANISM_QUOTED_PRINTABLE, MM_MAILMIME_MECHANISM_BASE64, MM_MAILMIME_MECHANISM_TOKEN }
enum	MAIL_STATUS_INCOMING { MAIL_STATUS_IN_UNKNOWN = 1, MAIL_STATUS_IN_SKIPPED = 2, MAIL_STATUS_IN_ERROR = 3, MAIL_STATUS_IN_PROCESSED = 4 }
enum	MAIL_STATUS_OUTGOING { MAIL_STATUS_OUT_SENT = 10, MAIL_STATUS_OUT_SCHEDULED = 11 }
Functions
const RealBlob &	MailAttachment::getBody (void) const
	Get body of attachment.
void	MailAttachment::setBody (const RealBlob &Body)
	Set body of attachment.
const Str &	MailAttachment::getFilename (void) const
	Get file name.
void	MailAttachment::setFilename (const Str &Filename)
	Set file name.
const Str &	MailAttachment::getCharset (void) const
	get char set
void	MailAttachment::setCharset (const Str &Charset)
	set char set
const Str &	MailAttachment::getContentType (void) const
	get content type
void	MailAttachment::setContentType (const Str &ContentType)
	set content type
bool	MailAttachment::isHtml (void) const
void	MailAttachment::setHtml (bool Html)
bool	MailAttachment::isText (void) const
void	MailAttachment::setText (bool Text)
bool	MailAttachment::isImage (void) const
void	MailAttachment::setImage (bool Image)
bool	MailAttachment::isAudio (void) const
void	MailAttachment::setAudio (bool Audio)
bool	MailAttachment::isVideo (void) const
void	MailAttachment::setVideo (bool Video)
bool	MailAttachment::isApplication (void) const
void	MailAttachment::setApplication (bool Application)
void	MailAttachment::setContentTransferEncoding (int input)
int	MailAttachment::getContentTransferEncoding (void)
	MailMessage::MailMessage (Str input)
const Str &	MailMessage::getFromName (void) const
void	MailMessage::setFromName (const Str &FromName)
void	MailMessage::setFromName (const Str &FromName, const Str &toEnc)
const Str &	MailMessage::getFromAddr (void) const
void	MailMessage::setFromAddr (const Str &FromAddr)
const Str &	MailMessage::getToName (void) const
void	MailMessage::setToName (const Str &ToName)
void	MailMessage::setToName (const Str &ToName, const Str &toEnc)
const Str &	MailMessage::getToAddr (void) const
void	MailMessage::setToAddr (const Str &ToAddr)
int	MailMessage::getDate (void) const
void	MailMessage::setDate (int Date)
const Str &	MailMessage::getSubject (void) const
void	MailMessage::setSubject (const Str &Subject)
void	MailMessage::setSubject (const Str &Subject, const Str &toEnc)
const Str &	MailMessage::getCcName (void) const
void	MailMessage::setCcName (const Str &CcName)
const Str &	MailMessage::getCcAddr (void) const
void	MailMessage::setCcAddr (const Str &CcAddr)
const Str &	MailMessage::getBccName (void) const
void	MailMessage::setBccName (const Str &BccName)
const Str &	MailMessage::getBccAddr (void) const
void	MailMessage::setBccAddr (const Str &BccAddr)
const Str &	MailMessage::getBody (void) const
void	MailMessage::setBody (const Str &Body)
const Str &	MailMessage::getFullHeader (void) const
void	MailMessage::setFullHeader (const Str &FullHeader)
const Str &	MailMessage::getContentType (void) const
void	MailMessage::setContentType (const Str &ContentType)
const Str &	MailMessage::getReportType (void) const
void	MailMessage::setReportType (const Str &ReportType)
const Str &	MailMessage::getCharset (void) const
void	MailMessage::setCharset (const Str &Charset)
void	MailMessage::setContentTransferEncoding (int)
int	MailMessage::getContentTransferEncoding (void)
size_t	MailMessage::getAttachments (void) const
MailAttachment	MailMessage::getAttachment (size_t index) const
void	MailMessage::addAttachment (const MailAttachment &Attachment)
	adding attachment to email
std::multimap< Str, Str >	MailMessage::getCustomHeaders (void) const
Str	MailMessage::stringify (void)
Int	MailMessage::sendMail (Int collectorID, Int secureBody=0)

---

Detailed Description

Example. Send Email.

 #include "MailMessage.hpp"

 void main(){
   MailMessage mm;
   mm.setContentType("text/plain");
   mm.setCharset("UTF8");
   mm.setSubject("<subject>");
   mm.setBody("<body>");
   mm.setToAddr  ("<mailto>");
   mm.setFromAddr("<mailfrom>");

   mm.sendMail(collectorID);
 }

---

Enumeration Type Documentation

enum MAIL_STATUS_INCOMING

Status of incoming email

Enumerator:

MAIL_STATUS_IN_UNKNOWN	Unknown email. (before processing)
MAIL_STATUS_IN_SKIPPED	Email was skipped.
MAIL_STATUS_IN_ERROR	Error while processsing email.
MAIL_STATUS_IN_PROCESSED	Email was processed.

enum MAIL_STATUS_OUTGOING

Status of outgoing email

Enumerator:

MAIL_STATUS_OUT_SENT	Email sent.
MAIL_STATUS_OUT_SCHEDULED	Email scheduled.

enum MM_MAILMIME

Enumerator:

MM_MAILMIME_MECHANISM_ERROR
MM_MAILMIME_MECHANISM_7BIT
MM_MAILMIME_MECHANISM_8BIT
MM_MAILMIME_MECHANISM_BINARY
MM_MAILMIME_MECHANISM_QUOTED_PRINTABLE
MM_MAILMIME_MECHANISM_BASE64
MM_MAILMIME_MECHANISM_TOKEN

---

Function Documentation

void MailMessage::addAttachment

(

const MailAttachment &

Attachment

)

adding attachment to email

Parameters:

Attachment

- attachment

MailAttachment MailMessage::getAttachment

(

size_t

index

)

const

Parameters:

index

of attachment

Returns:

attachemnt by index

size_t MailMessage::getAttachments

(

void

)

const

Returns:

number of attachments

const Str & MailMessage::getBccAddr

(

void

)

const

Returns:

Email Address from field "BCC"

const Str & MailMessage::getBccName

(

void

)

const

Returns:

Name from field "BCC"

const RealBlob & MailAttachment::getBody

(

void

)

const

Get body of attachment.

Returns:

blob of attachment

const Str & MailMessage::getBody

(

void

)

const

Returns:

Email body

const Str & MailMessage::getCcAddr

(

void

)

const

Returns:

Email Address from field "CC"

const Str & MailMessage::getCcName

(

void

)

const

Returns:

Name from field "CC"

const Str & MailAttachment::getCharset

(

void

)

const

get char set

Returns:

char set of attachment (e.g. "UTF-8")

const Str & MailMessage::getCharset

(

void

)

const

Returns:

char set

int MailAttachment::getContentTransferEncoding

(

void

)

Get content transfer encoding

Returns:

content transfer encoding, value of enum

See also:

MM_MAILMIME

int MailMessage::getContentTransferEncoding

(

void

)

Get content transfer encoding

Returns:

content transfer encoding, value of enum

See also:

MM_MAILMIME

const Str & MailAttachment::getContentType

(

void

)

const

get content type

Returns:

content type (e.g. "application/octet-stream")

const Str & MailMessage::getContentType

(

void

)

const

Parameters:

FullHeader

- email header

std::multimap< Str, Str > MailMessage::getCustomHeaders

(

void

)

const

Get custom headers

int MailMessage::getDate

(

void

)

const

Returns:

Date of email

const Str & MailAttachment::getFilename

(

void

)

const

Get file name.

Returns:

Name of file

const Str & MailMessage::getFromAddr

(

void

)

const

Returns:

email address, which will be used in "from" field

const Str & MailMessage::getFromName

(

void

)

const

Get From Name

Returns:

name of person from email was sent

const Str & MailMessage::getFullHeader

(

void

)

const

Returns:

email header

const Str & MailMessage::getReportType

(

void

)

const

Parameters:

Ful	- return report type from content type header

const Str & MailMessage::getSubject

(

void

)

const

Returns:

Email subject

const Str & MailMessage::getToAddr

(

void

)

const

Returns:

Email address from field "To"

const Str & MailMessage::getToName

(

void

)

const

Returns:

Name from field "To"

bool MailAttachment::isApplication

(

void

)

const

Returns:

Yes if attachment is application file.

bool MailAttachment::isAudio

(

void

)

const

Returns:

Yes if attachment is an audio file.

bool MailAttachment::isHtml

(

void

)

const

Returns:

Yes if attachment is html file.

bool MailAttachment::isImage

(

void

)

const

Returns:

Yes if attachment is an image file.

bool MailAttachment::isText

(

void

)

const

Returns:

Yes if attachment is text file.

bool MailAttachment::isVideo

(

void

)

const

Returns:

Yes if attachment is video file.

MailMessage::MailMessage

(

Str

input

)

Constructor of Str

Parameters:

input

is raw data of email

Int MailMessage::sendMail	(	Int	collectorID,
		Int	secureBody = 0
	)

Send Email

Parameters:

collectorID	is Id of collector in PBA
secureBody	hides email body

void MailAttachment::setApplication

(

bool

Application

)

Parameters:

Application

- If Yes - attachment is application file

void MailAttachment::setAudio

(

bool

Audio

)

Parameters:

Audio

- If Yes - attachment is audio file

void MailMessage::setBccAddr

(

const Str &

BccAddr

)

Parameters:

BccAddr

- Email Address from field "BCC"

void MailMessage::setBccName

(

const Str &

BccName

)

Parameters:

BccName

- Name from field "BCC"

void MailMessage::setBody

(

const Str &

Body

)

Parameters:

Body	- Email body

void MailAttachment::setBody

(

const RealBlob &

Body

)

Set body of attachment.

Parameters:

Body	- is real blob of attachment

void MailMessage::setCcAddr

(

const Str &

CcAddr

)

Parameters:

CcAddr

- Email Address from field "CC"

void MailMessage::setCcName

(

const Str &

CcName

)

Parameters:

CcName

- Name from field "CC"

void MailMessage::setCharset

(

const Str &

Charset

)

Parameters:

Charset

- char set

void MailAttachment::setCharset

(

const Str &

Charset

)

set char set

Parameters:

char	set of attachment (e.g. "UTF-8")

void MailAttachment::setContentTransferEncoding

(

int

input

)

Set Content Transfer Encoding

Parameters:

input

content transfer encoding, value of enum

See also:

MM_MAILMIME

void MailMessage::setContentTransferEncoding

(

int

iContentTransferEncoding

)

Set Content Transfer Encoding

Parameters:

input

content transfer encoding, value of enum

See also:

MM_MAILMIME

void MailAttachment::setContentType

(

const Str &

ContentType

)

set content type

Parameters:

content

type (e.g. "application/octet-stream")

void MailMessage::setContentType

(

const Str &

ContentType

)

Parameters:

ContentType

- content type

void MailMessage::setDate

(

int

Date

)

Parameters:

Date	is date of email

void MailAttachment::setFilename

(

const Str &

Filename

)

Set file name.

Parameters:

Filename

- name of file

void MailMessage::setFromAddr

(

const Str &

FromAddr

)

Parameters:

FromAddr

- email address in "from" field

void MailMessage::setFromName	(	const Str &	FromName,
		const Str &	toEnc
	)

Parameters:

FromName	- name of person from email was sent
toEnc	- encoding

void MailMessage::setFromName

(

const Str &

FromName

)

Parameters:

FromName

- name of person from email was sent

void MailMessage::setFullHeader

(

const Str &

FullHeader

)

Parameters:

FullHeader

- email header

void MailAttachment::setHtml

(

bool

Html

)

Parameters:

Html	- if Yes - attachment is html file

void MailAttachment::setImage

(

bool

Image

)

Parameters:

Image

- If Yes - attachment is text file

void MailMessage::setReportType

(

const Str &

ReportType

)

Parameters:

ReportType

- report type, delivery status

void MailMessage::setSubject	(	const Str &	Subject,
		const Str &	toEnc
	)

Parameters:

Subject	- Email subject
toEnc	- encoding

void MailMessage::setSubject

(

const Str &

Subject

)

Parameters:

Subject

- Email subject

void MailAttachment::setText

(

bool

Text

)

Parameters:

Text	- if Yes - attachment is text file

void MailMessage::setToAddr

(

const Str &

ToAddr

)

Parameters:

ToAddr

- Email address from field "To"

void MailMessage::setToName	(	const Str &	ToName,
		const Str &	toEnc
	)

Parameters:

ToName	- is a Name from field "To"
toEnc	- encoding

void MailMessage::setToName

(

const Str &

ToName

)

Parameters:

ToName

- is a Name from field "To"

void MailAttachment::setVideo

(

bool

Video

)

Parameters:

Video

is true if attachment is video file!!!!!

Str MailMessage::stringify

(

void

)

Returns:

string raw data of email.