#include <addressList.hpp>

Inheritance diagram for addressList:

[legend]

Collaboration diagram for addressList:

[legend]

Public Member Functions
	addressList ()
	addressList (const addressList &addrList)
	~addressList ()
shared_ptr< component >	clone () const
void	copyFrom (const component &other)
addressList &	operator= (const addressList &other)
addressList &	operator= (const mailboxList &other)
const std::vector< shared_ptr< component > >	getChildComponents ()
void	appendAddress (shared_ptr< address > addr)
void	insertAddressBefore (shared_ptr< address > beforeAddress, shared_ptr< address > addr)
void	insertAddressBefore (const size_t pos, shared_ptr< address > addr)
void	insertAddressAfter (shared_ptr< address > afterAddress, shared_ptr< address > addr)
void	insertAddressAfter (const size_t pos, shared_ptr< address > addr)
void	removeAddress (shared_ptr< address > addr)
void	removeAddress (const size_t pos)
void	removeAllAddresses ()
size_t	getAddressCount () const
bool	isEmpty () const
shared_ptr< address >	getAddressAt (const size_t pos)
const shared_ptr< const address >	getAddressAt (const size_t pos) const
const std::vector< shared_ptr< const address > >	getAddressList () const
const std::vector< shared_ptr< address > >	getAddressList ()
shared_ptr< mailboxList >	toMailboxList () 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 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 ()

Detailed Description

A list of addresses.

Constructor & Destructor Documentation

◆ addressList() [1/2]

addressList ( )

Referenced by addressList(), copyFrom(), operator=(), and operator=().

◆ addressList() [2/2]

addressList ( const addressList & addrList )

References addressList(), and copyFrom().

◆ ~addressList()

~addressList ( )

References removeAllAddresses().

Member Function Documentation

◆ appendAddress()

void appendAddress ( shared_ptr< address > addr )

Add a address at the end of the list.

Parameters

addr	address to append

Referenced by MDNHelper::buildMDN().

◆ clone()

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns: a copy of this component

Implements component.

◆ copyFrom()

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 addressList(), vmime::clone(), and removeAllAddresses().

Referenced by addressList(), and operator=().

◆ generateImpl()

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

protectedvirtual

Implements component.

References generationContext::getMaxLineLength(), and generationContext::setMaxLineLength().

◆ getAddressAt() [1/2]

shared_ptr< address > getAddressAt ( const size_t pos )

Return the address at the specified position.

Parameters

pos position

Returns: address at position 'pos'

Exceptions

std::out_of_range if the position is out of range

◆ getAddressAt() [2/2]

const shared_ptr< const address > getAddressAt ( const size_t pos ) const

Return the address at the specified position.

Parameters

pos position

Returns: address at position 'pos'

Exceptions

std::out_of_range if the position is out of range

◆ getAddressCount()

size_t getAddressCount ( ) const

Return the number of addresses in the list.

Returns: number of addresses

◆ getAddressList() [1/2]

const std::vector< shared_ptr< address > > getAddressList ( )

Return the address list.

Returns: list of addresses

◆ getAddressList() [2/2]

const std::vector< shared_ptr< const address > > getAddressList ( ) const

Return the address list.

Returns: list of addresses

◆ getChildComponents()

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().

◆ insertAddressAfter() [1/2]

void insertAddressAfter	(	const size_t	pos,
		shared_ptr< address >	addr )

Insert a new address after the specified position.

Parameters

pos	position of the address before the new address
addr	address to insert

Exceptions

std::out_of_range if the position is out of range

◆ insertAddressAfter() [2/2]

void insertAddressAfter	(	shared_ptr< address >	afterAddress,
		shared_ptr< address >	addr )

Insert a new address after the specified address.

Parameters

afterAddress	address after which the new address will be inserted
addr	address to insert

Exceptions

std::out_of_range if the address is not in the list

◆ insertAddressBefore() [1/2]

void insertAddressBefore	(	const size_t	pos,
		shared_ptr< address >	addr )

Insert a new address before the specified position.

Parameters

pos	position at which to insert the new address (0 to insert at the beginning of the list)
addr	address to insert

Exceptions

std::out_of_range if the position is out of range

◆ insertAddressBefore() [2/2]

void insertAddressBefore	(	shared_ptr< address >	beforeAddress,
		shared_ptr< address >	addr )

Insert a new address before the specified address.

Parameters

beforeAddress	address before which the new address will be inserted
addr	address to insert

Exceptions

std::out_of_range if the address is not in the list

◆ isEmpty()

bool isEmpty ( ) const

Tests whether the list of addresses is empty.

Returns: true if there is no address, false otherwise

◆ operator=() [1/2]

addressList & operator= ( const addressList & other )

References addressList(), and copyFrom().

◆ operator=() [2/2]

addressList & operator= ( const mailboxList & other )

References addressList(), vmime::dynamicCast(), mailboxList::getMailboxAt(), mailboxList::getMailboxCount(), and removeAllAddresses().

◆ parseImpl()

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::end(), address::parseNext(), removeAllAddresses(), and component::setParsedBounds().

◆ removeAddress() [1/2]

void removeAddress ( const size_t pos )

Remove the address at the specified position.

Parameters

pos	position of the address to remove

Exceptions

std::out_of_range if the position is out of range

◆ removeAddress() [2/2]

void removeAddress ( shared_ptr< address > addr )

Remove the specified address from the list.

Parameters

addr	address to remove

Exceptions

std::out_of_range if the address is not in the list

◆ removeAllAddresses()

void removeAllAddresses ( )

Remove all addresses from the list.

Referenced by copyFrom(), operator=(), parseImpl(), and ~addressList().

◆ toMailboxList()

shared_ptr< mailboxList > toMailboxList ( ) const

Return a list of mailboxes.

If some addresses are actually groups, mailboxes are recursively extracted from these groups.

Returns: list of mailboxes

References vmime::clone(), and vmime::dynamicCast().

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ addressList() [1/2]

◆ addressList() [2/2]

◆ ~addressList()

Member Function Documentation

◆ appendAddress()

◆ clone()

◆ copyFrom()

◆ generateImpl()

◆ getAddressAt() [1/2]

◆ getAddressAt() [2/2]

◆ getAddressCount()

◆ getAddressList() [1/2]

◆ getAddressList() [2/2]

◆ getChildComponents()

◆ insertAddressAfter() [1/2]

◆ insertAddressAfter() [2/2]

◆ insertAddressBefore() [1/2]

◆ insertAddressBefore() [2/2]

◆ isEmpty()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parseImpl()

◆ removeAddress() [1/2]

◆ removeAddress() [2/2]

◆ removeAllAddresses()

◆ toMailboxList()