disposition Class Reference

Disposition - from RFC-3798 (basic type). More...

Inheritance diagram for disposition:

[legend]

Collaboration diagram for disposition:

[legend]

List of all members.

Public Member Functions
	disposition ()
	disposition (const string &actionMode, const string &sendingMode, const string &type, const string &modifier)
ref< component >	clone () const
void	copyFrom (const component &other)
disposition &	operator= (const disposition &other)
const std::vector< ref< const component > >	getChildComponents () const
void	setActionMode (const string &mode)
const string &	getActionMode () const
void	setSendingMode (const string &mode)
const string &	getSendingMode () const
void	setType (const string &type)
const string &	getType () const
void	addModifier (const string &modifier)
void	removeModifier (const string &modifier)
void	removeAllModifiers ()
bool	hasModifier (const string &modifier) const
const std::vector< string >	getModifierList () const
void	parse (const string &buffer, const string::size_type position, const string::size_type end, string::size_type *newPosition=NULL)
void	generate (utility::outputStream &os, const string::size_type maxLineLength=lineLengthLimits::infinite, const string::size_type curLinePos=0, string::size_type *newLinePos=NULL) const

---

Detailed Description

Disposition - from RFC-3798 (basic type).

---

Constructor & Destructor Documentation

disposition

(

)

disposition	(	const string &	actionMode,
		const string &	sendingMode,
		const string &	type,
		const string &	modifier
	)

---

Member Function Documentation

void addModifier

(

const string &

modifier

)

Add a disposition modifier if it does not exist.

See the constants in vmime::dispositionModifiers.

Parameters:

modifier

modifier to add

References disposition::hasModifier(), and stringUtils::toLower().

ref< component > clone

(

)

const [virtual]

Clone this component.

Returns:

a copy of this component

Implements component.

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.

Referenced by disposition::operator=().

void generate	(	utility::outputStream &	os,
		const string::size_type	maxLineLength = lineLengthLimits::infinite,
		const string::size_type	curLinePos = 0,
		string::size_type *	newLinePos = NULL
	)			const [virtual]

Generate RFC-2822/MIME data for this component.

Parameters:

	os	output stream
	maxLineLength	maximum line length for output
	curLinePos	length of the current line in the output buffer
	newLinePos	will receive the new line position (length of the last line written)

Implements component.

References vmime::NEW_LINE_SEQUENCE, and vmime::NEW_LINE_SEQUENCE_LENGTH.

const string & getActionMode

(

)

const

Return the disposition action mode.

See the constants in vmime::dispositionActionModes.

Returns:

disposition action mode

const std::vector< ref< const component > > getChildComponents

(

)

const [virtual]

Return the list of children of this component (const version).

Returns:

list of child components

Implements component.

const std::vector< string > getModifierList

(

)

const

Return the list of modifiers.

Returns:

list of modifiers

const string & getSendingMode

(

)

const

Return the disposition sending mode.

See the constants in vmime::dispositionSendingModes.

Returns:

disposition sending mode

const string & getType

(

)

const

Return the disposition type.

See the constants in vmime::dispositionTypes.

Returns:

disposition type

bool hasModifier

(

const string &

modifier

)

const

Test whether a disposition modifier is set.

Parameters:

modifier

modifier to test

Returns:

true if the specified modifier is set, false otherwise

References stringUtils::toLower().

Referenced by disposition::addModifier().

disposition & operator=

(

const disposition &

other

)

References disposition::copyFrom().

void parse	(	const string &	buffer,
		const string::size_type	position,
		const string::size_type	end,
		string::size_type *	newPosition = NULL
	)			[virtual]

Parse RFC-822/MIME data for this component.

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

Implements component.

References parserHelpers::isSpace().

void removeAllModifiers

(

)

Remove all disposition modifiers.

void removeModifier

(

const string &

modifier

)

Remove the specified disposition modifier.

See the constants in vmime::dispositionModifiers.

Parameters:

modifier

modifier to remove

References stringUtils::toLower().

void setActionMode

(

const string &

mode

)

Set the disposition action mode.

See the constants in vmime::dispositionActionModes.

Parameters:

mode

disposition action mode

void setSendingMode

(

const string &

mode

)

Set the disposition sending mode.

See the constants in vmime::dispositionSendingModes.

Parameters:

mode

disposition sending mode

void setType

(

const string &

type

)

Set the disposition type.

See the constants in vmime::dispositionTypes.

Parameters:

type

disposition type

---

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

• disposition.hpp
• disposition.cpp