#include <component.hpp>

Inheritance diagram for component:

[legend]

Collaboration diagram for component:

Public Member Functions
	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 Member Functions
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

This abstract class is the base class for all the components of a message.

It defines methods for parsing and generating a component.

Constructor & Destructor Documentation

◆ component()

component ( )

◆ ~component()

~component ( )

virtual

Member Function Documentation

◆ clone()

virtual shared_ptr< component > clone ( ) const

pure virtual

Clone this component.

Returns: a copy of this component

Implemented in addressList, body, bodyPart, charset, contentDisposition, datetime, disposition, emailAddress, encoding, header, headerField, mailbox, mailboxGroup, mailboxList, mediaType, messageId, messageIdSequence, parameter, path, relay, text, word, and address.

◆ copyFrom()

virtual void copyFrom ( const component & other )

pure 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

Implemented in addressList, body, bodyPart, charset, contentDisposition, datetime, disposition, emailAddress, encoding, header, headerField, mailbox, mailboxGroup, mailboxList, mediaType, messageId, messageIdSequence, parameter, parameterizedHeaderField, path, relay, text, and word.

◆ 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 in emailAddress, and word.

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

◆ 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 in message, emailAddress, and word.

References vmime::dynamicCast(), component::generateImpl(), and generationContext::getDefaultContext().

Referenced by textPartFactory::create(), message::generate(), mailboxList::generateImpl(), relay::generateImpl(), encoding::getEncoder(), and headerFieldValue::getGeneratedSize().

◆ 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 in emailAddress, and word.

References vmime::dynamicCast(), component::generateImpl(), and generationContext::getDefaultContext().

◆ generateImpl()

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

protectedpure virtual

Implemented in addressList, body, bodyPart, charset, contentDisposition, datetime, disposition, emailAddress, encoding, header, headerField, mailbox, mailboxGroup, mailboxList, mediaType, messageId, messageIdSequence, parameter, parameterizedHeaderField, path, relay, text, and word.

Referenced by component::generate(), component::generate(), and component::generate().

◆ getChildComponents()

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

pure virtual

Return the list of children of this component.

Returns: list of child components

Implemented in addressList, body, bodyPart, charset, contentDisposition, datetime, disposition, emailAddress, encoding, header, headerField, mailbox, mailboxGroup, mailboxList, mediaType, messageId, messageIdSequence, parameter, parameterizedHeaderField, path, relay, text, and word.

Referenced by component::getGeneratedSize(), and emailAddress::parse().

◆ getGeneratedSize()

size_t getGeneratedSize ( const generationContext & ctx )

virtual

Get the number of bytes that will be used by this component when it is generated.

This may be a heuristically-derived estimate, but such an estimated size should always be larger than the actual generated size.

Parameters

ctx	generation context

Returns: component size when generated

Reimplemented in body, bodyPart, header, headerField, headerFieldValue, parameter, and parameterizedHeaderField.

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

Referenced by header::getGeneratedSize().

◆ getParsedLength()

size_t getParsedLength ( ) const

Return the length of this component in the parsed message contents.

Use for debugging only.

Returns: length of the component in parsed buffer or 0 if this component has not been parsed

◆ getParsedOffset()

size_t getParsedOffset ( ) const

Return the start position of this component in the parsed message contents.

Use for debugging only.

Returns: start position in parsed buffer or 0 if this component has not been parsed

◆ 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

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

◆ 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

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

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

◆ 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

Referenced by datetime::datetime(), mediaType::mediaType(), messageId::messageId(), messageId::operator=(), datetime::operator=(), mediaType::operator=(), component::parse(), emailAddress::parseImpl(), relay::parseImpl(), body::parseImpl(), mediaType::setFromString(), and headerField::setValue().

◆ 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::dynamicCast(), and component::parse().

◆ 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

◆ parseImpl() [1/2]

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

protectedvirtual

Reimplemented in addressList, charset, contentDisposition, datetime, disposition, emailAddress, encoding, header, headerField, mailbox, mailboxGroup, mailboxList, mediaType, messageId, messageIdSequence, parameter, parameterizedHeaderField, path, relay, text, and word.

◆ parseImpl() [2/2]

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

protectedvirtual

Reimplemented in body, and bodyPart.

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

Referenced by emailAddress::generate(), component::parse(), component::parse(), emailAddress::parse(), and component::parseImpl().

◆ setParsedBounds()

void setParsedBounds	(	const size_t	start,
		const size_t	end
	)

protected

References vmime::end().

Referenced by addressList::parseImpl(), charset::parseImpl(), contentDisposition::parseImpl(), datetime::parseImpl(), emailAddress::parseImpl(), encoding::parseImpl(), header::parseImpl(), mailbox::parseImpl(), mailboxGroup::parseImpl(), mailboxList::parseImpl(), mediaType::parseImpl(), messageId::parseImpl(), messageIdSequence::parseImpl(), relay::parseImpl(), text::parseImpl(), body::parseImpl(), bodyPart::parseImpl(), and word::parseWithState().

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ component()

◆ ~component()

Member Function Documentation

◆ clone()

◆ copyFrom()

◆ generate() [1/3]

◆ generate() [2/3]

◆ generate() [3/3]

◆ generateImpl()

◆ getChildComponents()

◆ getGeneratedSize()

◆ getParsedLength()

◆ getParsedOffset()

◆ parse() [1/7]

◆ parse() [2/7]

◆ parse() [3/7]

◆ parse() [4/7]

◆ parse() [5/7]

◆ parse() [6/7]

◆ parse() [7/7]

◆ parseImpl() [1/2]

◆ parseImpl() [2/2]

◆ setParsedBounds()