#include <emailAddress.hpp>

Inheritance diagram for emailAddress:

[legend]

Collaboration diagram for emailAddress:

[legend]

Public Member Functions
	emailAddress ()

	emailAddress (const emailAddress &eml)

	emailAddress (const string &email)

	emailAddress (const char *email)

	emailAddress (const string &localName, const string &domainName)

	emailAddress (const word &localName, const word &domainName)

const word &	getLocalName () const

void	setLocalName (const word &localName)

const word &	getDomainName () const

void	setDomainName (const word &domainName)

bool	isEmpty () const

const string	toString () const

const text	toText () const

bool	operator== (const class emailAddress &eml) const

bool	operator!= (const class emailAddress &eml) const

void	copyFrom (const component &other)

shared_ptr< component >	clone () const

emailAddress &	operator= (const emailAddress &other)

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

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

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

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)

size_t	getParsedOffset () const

size_t	getParsedLength () const

virtual size_t	getGeneratedSize (const generationContext &ctx)

Protected Attributes
word	m_localName

word	m_domainName

Additional Inherited Members
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

An email address: local name and domain name (basic type).

Constructor & Destructor Documentation

◆ emailAddress() [1/6]

emailAddress ( )

◆ emailAddress() [2/6]

emailAddress ( const emailAddress & eml )

◆ emailAddress() [3/6]

emailAddress ( const string & email )

References vmime::dynamicCast(), and emailAddress::parse().

◆ emailAddress() [4/6]

emailAddress ( const char * email )

References vmime::dynamicCast(), and emailAddress::parse().

◆ emailAddress() [5/6]

emailAddress	(	const string &	localName,
		const string &	domainName
	)

◆ emailAddress() [6/6]

emailAddress	(	const word &	localName,
		const word &	domainName
	)

Member Function Documentation

◆ clone()

shared_ptr< component > clone ( ) const

virtual

Clone this component.

Returns: a copy of this component

Implements component.

References vmime::dynamicCast().

◆ 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 vmime::dynamicCast(), emailAddress::m_domainName, and emailAddress::m_localName.

Referenced by emailAddress::operator=().

◆ generate() [1/3]

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

virtual

Generate RFC-2822/MIME data for this component, using the default generation context.

Parameters

ctx	generation context
outputStream	output stream
curLinePos	length of the current line in the output buffer
newLinePos	will receive the new line position (length of the last line written)

Reimplemented from component.

References vmime::dynamicCast(), vmime::end(), and component::parseImpl().

◆ generate() [2/3]

const string generate	(	const size_t	maxLineLength = `lineLengthLimits::infinite`,
		const size_t	curLinePos = `0`
	)		const

virtual

Generate RFC-2822/MIME data for this component.

Deprecated:: Use the new generate() method, which takes an outputStream parameter.

Parameters

maxLineLength	maximum line length for output
curLinePos	length of the current line in the output buffer

Returns: generated data

Reimplemented from component.

Referenced by mailbox::generateImpl().

◆ generate() [3/3]

void generate	(	utility::outputStream &	outputStream,
		const size_t	curLinePos = `0`,
		size_t *	newLinePos = `NULL`
	)		const

virtual

Generate RFC-2822/MIME data for this component, using the default generation context.

Parameters

outputStream	output stream
curLinePos	length of the current line in the output buffer
newLinePos	will receive the new line position (length of the last line written)

Reimplemented from component.

◆ generateImpl()

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

virtual

Implements component.

References vmime::dynamicCast(), text::FORCE_NO_ENCODING, word::generate(), word::getBuffer(), word::getConvertedText(), stringUtils::is7bit(), emailAddress::m_domainName, emailAddress::m_localName, text::QUOTE_IF_NEEDED, and vmime::charsets::UTF_8.

Referenced by emailAddress::toString().

◆ getChildComponents()

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

virtual

Return the list of children of this component.

Returns: list of child components

Implements component.

◆ getDomainName()

const word & getDomainName ( ) const

Return the domain name of the address.

Returns: domain name of the address

References emailAddress::m_domainName.

◆ getLocalName()

const word & getLocalName ( ) const

Return the local name of the address.

Returns: local name of the address

References emailAddress::m_localName.

◆ isEmpty()

bool isEmpty ( ) const

Returns whether this email address is empty.

Address is considered as empty if the local part is not specified.

Returns: true if the address is empty, false otherwise

References word::isEmpty(), and emailAddress::m_localName.

Referenced by mailbox::isEmpty().

◆ operator!=()

bool operator!= ( const class emailAddress & eml ) const

References vmime::dynamicCast().

◆ operator=()

emailAddress & operator= ( const emailAddress & other )

References emailAddress::copyFrom().

◆ operator==()

bool operator== ( const class emailAddress & eml ) const

References vmime::dynamicCast(), emailAddress::m_domainName, and emailAddress::m_localName.

◆ parse() [1/7]

void parse	(	const parsingContext &	ctx,
		const string &	buffer
	)

Parse RFC-822/MIME data for this component.

Parameters

ctx	parsing context
buffer	input buffer

◆ parse() [2/7]

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

Parse RFC-822/MIME data for this component.

Parameters

ctx	parsing context
buffer	input buffer
position	current position in the input buffer
end	end position in the input buffer
newPosition	will receive the new position in the input buffer

◆ parse() [3/7]

void parse	(	const parsingContext &	ctx,
		shared_ptr< utility::inputStream >	inputStream,
		const size_t	position,
		const size_t	end,
		size_t *	newPosition = `NULL`
	)

Parse RFC-822/MIME data for this component.

If stream is not seekable, or if end position is not specified, entire contents of the stream will be loaded into memory before parsing.

Parameters

ctx	parsing context
inputStream	stream from which to read data
position	current position in the input stream
end	end position in the input stream
newPosition	will receive the new position in the input stream

References vmime::dynamicCast(), and component::getChildComponents().

◆ parse() [4/7]

void parse ( const string & buffer )

Parse RFC-822/MIME data for this component, using the default parsing context.

Parameters

buffer input buffer

References vmime::dynamicCast(), vmime::end(), and parsingContext::getDefaultContext().

Referenced by emailAddress::emailAddress(), emailAddress::emailAddress(), and mailbox::parseImpl().

◆ parse() [5/7]

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

Parse RFC-822/MIME data for this component, using the default parsing context.

Parameters

buffer	input buffer
position	current position in the input buffer
end	end position in the input buffer
newPosition	will receive the new position in the input buffer

◆ parse() [6/7]

void parse	(	shared_ptr< utility::inputStream >	inputStream,
		const size_t	length
	)

Parse RFC-822/MIME data for this component.

If stream is not seekable, or if length is not specified, entire contents of the stream will be loaded into memory before parsing.

Parameters

inputStream	stream from which to read data
length	data length, in bytes (0 = unknown/not specified)

References vmime::utility::bufferedStreamCopyRange(), vmime::dynamicCast(), and vmime::end().

◆ parse() [7/7]

void parse	(	shared_ptr< utility::inputStream >	inputStream,
		const size_t	position,
		const size_t	end,
		size_t *	newPosition = `NULL`
	)

Parse RFC-822/MIME data for this component.

If stream is not seekable, or if end position is not specified, entire contents of the stream will be loaded into memory before parsing. The default parsing context will be used.

Parameters

inputStream	stream from which to read data
position	current position in the input stream
end	end position in the input stream
newPosition	will receive the new position in the input stream

References vmime::dynamicCast(), vmime::end(), parsingContext::getDefaultContext(), and component::parseImpl().

◆ 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 vmime::dynamicCast(), vmime::end(), platform::getHandler(), parserHelpers::isSpace(), emailAddress::m_domainName, emailAddress::m_localName, component::parse(), component::setParsedBounds(), and vmime::charsets::UTF_8.

◆ setDomainName()

void setDomainName ( const word & domainName )

Set the domain name of the address.

Parameters

domainName domain name of the address

References vmime::dynamicCast(), and emailAddress::m_domainName.

◆ setLocalName()

void setLocalName ( const word & localName )

Set the local name of the address.

Parameters

localName local name of the address

References vmime::dynamicCast(), and emailAddress::m_localName.

◆ toString()

const string toString ( ) const

Returns the email address as a string, by joining components.

(ie. the local name, followed by a @ then the domain name.)

Returns: email address as a string

References vmime::dynamicCast(), emailAddress::generateImpl(), generationContext::getDefaultContext(), and vmime::lineLengthLimits::infinite.

◆ toText()

const text toText ( ) const

Returns the email address as multibyte text, by joining components.

(ie. the local name, followed by a @ then the domain name.)

Returns: email address as multibyte text

References text::appendWord(), vmime::dynamicCast(), emailAddress::m_domainName, emailAddress::m_localName, and vmime::charsets::US_ASCII.

Member Data Documentation

◆ m_domainName

word m_domainName

protected

Referenced by emailAddress::copyFrom(), emailAddress::generateImpl(), emailAddress::getDomainName(), emailAddress::operator==(), emailAddress::parseImpl(), emailAddress::setDomainName(), and emailAddress::toText().

◆ m_localName

word m_localName

protected

Referenced by emailAddress::copyFrom(), emailAddress::generateImpl(), emailAddress::getLocalName(), emailAddress::isEmpty(), emailAddress::operator==(), emailAddress::parseImpl(), emailAddress::setLocalName(), and emailAddress::toText().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ emailAddress() [1/6]

◆ emailAddress() [2/6]

◆ emailAddress() [3/6]

◆ emailAddress() [4/6]

◆ emailAddress() [5/6]

◆ emailAddress() [6/6]

Member Function Documentation

◆ clone()

◆ copyFrom()

◆ generate() [1/3]

◆ generate() [2/3]

◆ generate() [3/3]

◆ generateImpl()

◆ getChildComponents()

◆ getDomainName()

◆ getLocalName()

◆ isEmpty()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ parse() [1/7]

◆ parse() [2/7]

◆ parse() [3/7]

◆ parse() [4/7]

◆ parse() [5/7]

◆ parse() [6/7]

◆ parse() [7/7]

◆ parseImpl()

◆ setDomainName()

◆ setLocalName()

◆ toString()

◆ toText()

Member Data Documentation

◆ m_domainName

◆ m_localName