mailboxGroup Class Reference

Inheritance diagram for mailboxGroup:

Collaboration diagram for mailboxGroup:

Public Member Functions
	mailboxGroup ()
	mailboxGroup (const mailboxGroup &mboxGroup)
	mailboxGroup (const text &name)
	~mailboxGroup ()
void	copyFrom (const component &other)
shared_ptr< component >	clone () const
mailboxGroup &	operator= (const component &other)
const std::vector< shared_ptr < component > >	getChildComponents ()
const text &	getName () const
void	setName (const text &name)
void	appendMailbox (shared_ptr< mailbox > mbox)
void	insertMailboxBefore (shared_ptr< mailbox > beforeMailbox, shared_ptr< mailbox > mbox)
void	insertMailboxBefore (const size_t pos, shared_ptr< mailbox > mbox)
void	insertMailboxAfter (shared_ptr< mailbox > afterMailbox, shared_ptr< mailbox > mbox)
void	insertMailboxAfter (const size_t pos, shared_ptr< mailbox > mbox)
void	removeMailbox (shared_ptr< mailbox > mbox)
void	removeMailbox (const size_t pos)
void	removeAllMailboxes ()
size_t	getMailboxCount () const
bool	isEmpty () const
shared_ptr< mailbox >	getMailboxAt (const size_t pos)
const shared_ptr< const mailbox >	getMailboxAt (const size_t pos) const
const std::vector< shared_ptr < const mailbox > >	getMailboxList () const
const std::vector< shared_ptr < mailbox > >	getMailboxList ()
bool	isGroup () const
Public Member Functions inherited from headerFieldValue
size_t	getGeneratedSize (const generationContext &ctx)
Public Member Functions inherited from component
	component ()
virtual	~component ()
void	parse (const string &buffer)
void	parse (const parsingContext &ctx, const string &buffer)
void	parse (shared_ptr< utility::inputStream > inputStream, const size_t length)
void	parse (const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
void	parse (const parsingContext &ctx, shared_ptr< utility::inputStream > inputStream, const size_t position, const size_t end, size_t *newPosition=NULL)
virtual const string	generate (const size_t maxLineLength=lineLengthLimits::infinite, const size_t curLinePos=0) const
virtual void	generate (utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
virtual void	generate (const generationContext &ctx, utility::outputStream &outputStream, const size_t curLinePos=0, size_t *newLinePos=NULL) const
size_t	getParsedOffset () const
size_t	getParsedLength () const

Protected Member Functions
void	parseImpl (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition=NULL)
void	generateImpl (const generationContext &ctx, utility::outputStream &os, const size_t curLinePos=0, size_t *newLinePos=NULL) const
Protected Member Functions inherited from address
	address ()
Protected Member Functions inherited from component
void	setParsedBounds (const size_t start, const size_t end)
virtual void	parseImpl (const parsingContext &ctx, shared_ptr< utility::parserInputStreamAdapter > parser, const size_t position, const size_t end, size_t *newPosition=NULL)
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Additional Inherited Members
Static Public Member Functions inherited from address
static shared_ptr< address >	parseNext (const parsingContext &ctx, const string &buffer, const size_t position, const size_t end, size_t *newPosition, bool *isLastAddressOfGroup)

Detailed Description

A group of mailboxes (basic type).

Constructor & Destructor Documentation

mailboxGroup

(

)

mailboxGroup

(

const mailboxGroup &

mboxGroup

)

References mailboxGroup::copyFrom().

mailboxGroup

(

const text &

name

)

~mailboxGroup

(

)

References mailboxGroup::removeAllMailboxes().

Member Function Documentation

void appendMailbox

(

shared_ptr< mailbox >

mbox

)

Add a mailbox at the end of the list.

Parameters

mbox	mailbox to append

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns

a copy of this component

Implements address.

void copyFrom ( const component &  other )

virtual

Replace data in this component by data in other component.

Both components must be of the same type.

Exceptions

std::bad_cast_exception

if the components are not of the same (dynamic) type

Parameters

other

other component to copy data from

Implements component.

References vmime::clone(), and mailboxGroup::removeAllMailboxes().

Referenced by mailboxGroup::mailboxGroup(), and mailboxGroup::operator=().

void generateImpl ( const generationContext &  ctx, utility::outputStream &  os, const size_t  curLinePos = 0, size_t *  newLinePos = NULL  ) const

protectedvirtual

Implements component.

References text::FORCE_ENCODING, generationContext::getMaxLineLength(), generationContext::setMaxLineLength(), and vmime::charsets::US_ASCII.

const std::vector< shared_ptr< component > > getChildComponents ( )

virtual

Return the list of children of this component.

Returns

list of child components

Implements component.

References vmime::copy_vector().

shared_ptr< mailbox > getMailboxAt

(

const size_t

pos

)

Return the mailbox at the specified position.

Parameters

pos

position

Returns

mailbox at position 'pos'

Exceptions

std::out_of_range

if the position is out of range

const shared_ptr< const mailbox > getMailboxAt

(

const size_t

pos

)

const

Return the mailbox at the specified position.

Parameters

pos

position

Returns

mailbox at position 'pos'

Exceptions

std::out_of_range

if the position is out of range

size_t getMailboxCount

(

)

const

Return the number of mailboxes in the list.

Returns

number of mailboxes

const std::vector< shared_ptr< const mailbox > > getMailboxList

(

)

const

Return the mailbox list.

Returns

list of mailboxes

const std::vector< shared_ptr< mailbox > > getMailboxList

(

)

Return the mailbox list.

Returns

list of mailboxes

const text & getName

(

)

const

Return the name of the group.

Returns

group name

void insertMailboxAfter	(	shared_ptr< mailbox >	afterMailbox,
		shared_ptr< mailbox >	mbox
	)

Insert a new mailbox after the specified mailbox.

Parameters

afterMailbox	mailbox after which the new mailbox will be inserted
mbox	mailbox to insert

Exceptions

std::out_of_range

if the mailbox is not in the list

void insertMailboxAfter	(	const size_t	pos,
		shared_ptr< mailbox >	mbox
	)

Insert a new mailbox after the specified position.

Parameters

pos	position of the mailbox before the new mailbox
mbox	mailbox to insert

Exceptions

std::out_of_range

if the position is out of range

void insertMailboxBefore	(	shared_ptr< mailbox >	beforeMailbox,
		shared_ptr< mailbox >	mbox
	)

Insert a new mailbox before the specified mailbox.

Parameters

beforeMailbox	mailbox before which the new mailbox will be inserted
mbox	mailbox to insert

Exceptions

std::out_of_range

if the mailbox is not in the list

void insertMailboxBefore	(	const size_t	pos,
		shared_ptr< mailbox >	mbox
	)

Insert a new mailbox before the specified position.

Parameters

pos	position at which to insert the new mailbox (0 to insert at the beginning of the list)
mbox	mailbox to insert

Exceptions

std::out_of_range

if the position is out of range

bool isEmpty ( ) const

virtual

Tests whether the list of mailboxes is empty.

Returns

true if there is no mailbox, false otherwise

Implements address.

bool isGroup ( ) const

virtual

Test whether this is object is a mailboxGroup.

Returns

true if this is a mailboxGroup, false otherwise

Implements address.

mailboxGroup & operator=

(

const component &

other

)

References mailboxGroup::copyFrom().

void parseImpl ( const parsingContext &  ctx, const string &  buffer, const size_t  position, const size_t  end, size_t *  newPosition = NULL  )

protectedvirtual

Reimplemented from component.

References vmime::clone(), text::decodeAndUnfold(), vmime::end(), parserHelpers::isSpace(), address::parseNext(), and stringUtils::trim().

void removeAllMailboxes

(

)

Remove all mailboxes from the list.

Referenced by mailboxGroup::copyFrom(), and mailboxGroup::~mailboxGroup().

void removeMailbox

(

shared_ptr< mailbox >

mbox

)

Remove the specified mailbox from the list.

Parameters

mbox	mailbox to remove

Exceptions

std::out_of_range

if the mailbox is not in the list

void removeMailbox

(

const size_t

pos

)

Remove the mailbox at the specified position.

Parameters

pos	position of the mailbox to remove

Exceptions

std::out_of_range

if the position is out of range

void setName

(

const text &

name

)

Set the name of the group.

Parameters

name	group name

---

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

• mailboxGroup.hpp
• mailboxGroup.cpp