#include <mailbox.hpp>

Inheritance diagram for mailbox:

[legend]

Collaboration diagram for mailbox:

[legend]

Public Member Functions
	mailbox ()

	mailbox (const mailbox &mbox)

	mailbox (const emailAddress &email)

	mailbox (const text &name, const emailAddress &email)

const text &	getName () const

void	setName (const text &name)

const emailAddress &	getEmail () const

void	setEmail (const emailAddress &email)

bool	operator== (const class mailbox &mailbox) const

bool	operator!= (const class mailbox &mailbox) const

void	copyFrom (const component &other)

shared_ptr< component >	clone () const

mailbox &	operator= (const mailbox &other)

bool	isEmpty () const

void	clear ()

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

bool	isGroup () const

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

virtual bool	isEmpty () const =0

virtual bool	isGroup () const =0

virtual shared_ptr< component >	clone () const =0

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

virtual shared_ptr< component >	clone () const =0

virtual void	copyFrom (const component &other)=0

size_t	getParsedOffset () const

size_t	getParsedLength () const

virtual const std::vector< shared_ptr< component > >	getChildComponents ()=0

virtual size_t	getGeneratedSize (const generationContext &ctx)

Protected Attributes
text	m_name

emailAddress	m_email

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)

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)

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

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

Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Detailed Description

A mailbox: full name + email (basic type).

Constructor & Destructor Documentation

◆ mailbox() [1/4]

mailbox ( )

Referenced by IMAPFolder::getFolders(), and mailbox::operator!=().

◆ mailbox() [2/4]

mailbox ( const mailbox & mbox )

◆ mailbox() [3/4]

mailbox ( const emailAddress & email )

◆ mailbox() [4/4]

mailbox	(	const text &	name,
		const emailAddress &	email
	)

Member Function Documentation

◆ clear()

void clear ( )

References mailbox::m_email, mailbox::m_name, and text::removeAllWords().

◆ clone()

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns: a copy of this component

Implements address.

◆ 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 mailbox::m_email, and mailbox::m_name.

Referenced by mailbox::operator=().

◆ generateImpl()

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

virtual

Implements component.

References text::encodeAndFold(), text::FORCE_ENCODING, emailAddress::generate(), generationContext::getMaxLineLength(), text::getWordAt(), text::getWordCount(), text::isEmpty(), mailbox::m_email, mailbox::m_name, vmime::NEW_LINE_SEQUENCE, text::QUOTE_IF_POSSIBLE, and vmime::charsets::US_ASCII.

◆ getChildComponents()

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

virtual

Return the list of children of this component.

Returns: list of child components

Implements component.

◆ getEmail()

const emailAddress & getEmail ( ) const

Return the email of the mailbox.

Returns: email of the mailbox

References mailbox::m_email.

Referenced by SMTPCommand::MAIL(), MDNHelper::needConfirmation(), SMTPCommand::RCPT(), and sendmailTransport::send().

◆ getName()

const text & getName ( ) const

Return the full name of the mailbox (empty if not specified).

Returns: full name of the mailbox

References mailbox::m_name.

◆ isEmpty()

bool isEmpty ( ) const

virtual

Check whether this address is empty (no mailboxes specified if this is a mailboxGroup -or- no email specified if this is a mailbox).

Returns: true if this address is empty

Implements address.

References emailAddress::isEmpty(), and mailbox::m_email.

Referenced by messageBuilder::construct(), and sendmailTransport::send().

◆ isGroup()

bool isGroup ( ) const

virtual

Test whether this is object is a mailboxGroup.

Returns: true if this is a mailboxGroup, false otherwise

Implements address.

◆ operator!=()

bool operator!= ( const class mailbox & mailbox ) const

References mailbox::mailbox().

◆ operator=()

mailbox & operator= ( const mailbox & other )

References mailbox::copyFrom().

◆ operator==()

bool operator== ( const class mailbox & mailbox ) const

References mailbox::m_email, and mailbox::m_name.

◆ parseImpl()

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

virtual

Reimplemented from component.

References address::address(), text::decodeAndUnfold(), vmime::end(), parserHelpers::isSpace(), mailbox::m_email, mailbox::m_name, emailAddress::parse(), text::removeAllWords(), and component::setParsedBounds().

◆ setEmail()

void setEmail ( const emailAddress & email )

Set the email of the mailbox.

Parameters

email email of the mailbox

References mailbox::m_email.

◆ setName()

void setName ( const text & name )

Set the full name of the mailbox.

Parameters

name	full name of the mailbox

References mailbox::m_name.

Member Data Documentation

◆ m_email

emailAddress m_email

protected

Referenced by mailbox::clear(), mailbox::copyFrom(), mailbox::generateImpl(), mailbox::getEmail(), mailbox::isEmpty(), mailbox::operator==(), mailbox::parseImpl(), and mailbox::setEmail().

◆ m_name

text m_name

protected

Referenced by mailbox::clear(), mailbox::copyFrom(), mailbox::generateImpl(), mailbox::getName(), mailbox::operator==(), mailbox::parseImpl(), and mailbox::setName().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mailbox() [1/4]

◆ mailbox() [2/4]

◆ mailbox() [3/4]

◆ mailbox() [4/4]

Member Function Documentation

◆ clear()

◆ clone()

◆ copyFrom()

◆ generateImpl()

◆ getChildComponents()

◆ getEmail()

◆ getName()

◆ isEmpty()

◆ isGroup()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ parseImpl()

◆ setEmail()

◆ setName()

Member Data Documentation

◆ m_email

◆ m_name