#include <htmlTextPart.hpp>

Inheritance diagram for htmlTextPart:

[legend]

Collaboration diagram for htmlTextPart:

[legend]

Classes
class	embeddedObject

Public Member Functions
	htmlTextPart ()

	~htmlTextPart ()

const mediaType	getType () const

const charset &	getCharset () const

void	setCharset (const charset &ch)

shared_ptr< const contentHandler >	getPlainText () const

void	setPlainText (shared_ptr< contentHandler > plainText)

const shared_ptr< const contentHandler >	getText () const

void	setText (shared_ptr< contentHandler > text)

bool	hasObject (const string &id) const

shared_ptr< const embeddedObject >	findObject (const string &id) const

size_t	getObjectCount () const

shared_ptr< const embeddedObject >	getObjectAt (const size_t pos) const

shared_ptr< const embeddedObject >	addObject (const string &data, const mediaType &type)

shared_ptr< const embeddedObject >	addObject (shared_ptr< contentHandler > data, const mediaType &type)

shared_ptr< const embeddedObject >	addObject (shared_ptr< contentHandler > data, const encoding &enc, const mediaType &type)

size_t	getPartCount () const

void	generateIn (shared_ptr< bodyPart > message, shared_ptr< bodyPart > parent) const

void	parse (shared_ptr< const bodyPart > message, shared_ptr< const bodyPart > parent, shared_ptr< const bodyPart > textPart)

Public Member Functions inherited from textPart
virtual	~textPart ()

Additional Inherited Members
Protected Member Functions inherited from object
	object ()

	object (const object &)

object &	operator= (const object &)

virtual	~object ()

Detailed Description

Text part of type 'text/html'.

Constructor & Destructor Documentation

◆ htmlTextPart()

htmlTextPart ( )

◆ ~htmlTextPart()

~htmlTextPart ( )

Member Function Documentation

◆ addObject() [1/3]

shared_ptr< const htmlTextPart::embeddedObject > addObject	(	const string &	data,
		const mediaType &	type
	)

Embed an object and returns a string which identifies it.

The returned identifier is suitable for use in the 'src' attribute of an <img> tag.

Deprecated:: Use the addObject() methods which take a 'contentHandler' parameter type instead.

Parameters

data	object data
type	data type

Returns: an unique object identifier used to identify the new object among all other embedded objects

References htmlTextPart::addObject(), encoding::decide(), and vmime::dynamicCast().

Referenced by htmlTextPart::addObject(), and htmlTextPart::addObject().

◆ addObject() [2/3]

shared_ptr< const htmlTextPart::embeddedObject > addObject	(	shared_ptr< contentHandler >	data,
		const encoding &	enc,
		const mediaType &	type
	)

Embed an object and returns a string which identifies it.

The returned identifier is suitable for use in the 'src' attribute of an <img> tag.

Parameters

data	object data
enc	data encoding
type	data type

Returns: an unique object identifier used to identify the new object among all other embedded objects

References vmime::dynamicCast(), messageId::generateId(), and htmlTextPart::embeddedObject::REFERENCED_BY_ID.

◆ addObject() [3/3]

shared_ptr< const htmlTextPart::embeddedObject > addObject	(	shared_ptr< contentHandler >	data,
		const mediaType &	type
	)

Embed an object and returns a string which identifies it.

The returned identifier is suitable for use in the 'src' attribute of an <img> tag.

Parameters

data	object data
type	data type

Returns: an unique object identifier used to identify the new object among all other embedded objects

References htmlTextPart::addObject(), encoding::decide(), and vmime::dynamicCast().

◆ findObject()

shared_ptr< const htmlTextPart::embeddedObject > findObject ( const string & id ) const

Return the embedded object with the specified identifier.

Parameters

id	object identifier

Returns: embedded object with the specified identifier, or NULL if no object has been found

References vmime::dynamicCast().

◆ generateIn()

void generateIn	(	shared_ptr< bodyPart >	message,
		shared_ptr< bodyPart >	parent
	)		const

virtual

Generate the text part(s) into the specified message.

Parameters

message	the message
parent	body part into which generate this part

Implements textPart.

References encoding::decide(), vmime::dynamicCast(), vmime::contentDispositionTypes::INLINE, vmime::mediaTypes::MULTIPART, vmime::mediaTypes::MULTIPART_RELATED, vmime::mediaTypes::TEXT, vmime::mediaTypes::TEXT_HTML, vmime::mediaTypes::TEXT_PLAIN, and encoding::USAGE_TEXT.

◆ getCharset()

const charset & getCharset ( ) const

virtual

Return the charset used to encode text in the text part.

Returns: text charset

Implements textPart.

◆ getObjectAt()

shared_ptr< const htmlTextPart::embeddedObject > getObjectAt ( const size_t pos ) const

Return the embedded object at the specified position.

Parameters

pos	position of the embedded object

Returns: embedded object at position 'pos'

References vmime::dynamicCast().

◆ getObjectCount()

size_t getObjectCount ( ) const

Return the number of embedded objects.

Returns: number of embedded objects

◆ getPartCount()

size_t getPartCount ( ) const

virtual

Return the actual body parts this text part is composed of.

For example, HTML parts are composed of two parts: one "text/html" part, and the plain text part "text/plain".

Returns: number of body parts

Implements textPart.

◆ getPlainText()

shared_ptr< const contentHandler > getPlainText ( ) const

◆ getText()

const shared_ptr< const contentHandler > getText ( ) const

virtual

Return the text contained in the part.

Returns: text of the part

Implements textPart.

◆ getType()

const mediaType getType ( ) const

virtual

Return the type of text part (eg: "text/html").

Returns: type of text part

Implements textPart.

References vmime::mediaTypes::TEXT, and vmime::mediaTypes::TEXT_HTML.

◆ hasObject()

bool hasObject ( const string & id ) const

Test the existence of an embedded object given its identifier.

Parameters

id	object identifier

Returns: true if an object with this identifier exists, false otherwise

References vmime::dynamicCast().

◆ parse()

void parse	(	shared_ptr< const bodyPart >	message,
		shared_ptr< const bodyPart >	parent,
		shared_ptr< const bodyPart >	textPart
	)

virtual

Parse the text part(s) from the specified message.

Parameters

message	message containing the text part
parent	part containing the text part
textPart	actual text part

Implements textPart.

References vmime::fields::CONTENT_ID, vmime::fields::CONTENT_LOCATION, vmime::fields::CONTENT_TYPE, vmime::dynamicCast(), text::getWholeBuffer(), htmlTextPart::embeddedObject::REFERENCED_BY_ID, and htmlTextPart::embeddedObject::REFERENCED_BY_LOCATION.

◆ setCharset()

void setCharset ( const charset & ch )

virtual

Set the charset used to encode text in the text part.

Parameters

ch	text charset

Implements textPart.

References vmime::dynamicCast().

◆ setPlainText()

void setPlainText ( shared_ptr< contentHandler > plainText )

References vmime::dynamicCast().

◆ setText()

void setText ( shared_ptr< contentHandler > text )

virtual

Set the text contained in the part.

Parameters

text	text of the part

Implements textPart.

References text::clone().

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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ htmlTextPart()

◆ ~htmlTextPart()

Member Function Documentation

◆ addObject() [1/3]

◆ addObject() [2/3]

◆ addObject() [3/3]

◆ findObject()

◆ generateIn()

◆ getCharset()

◆ getObjectAt()

◆ getObjectCount()

◆ getPartCount()

◆ getPlainText()

◆ getText()

◆ getType()

◆ hasObject()

◆ parse()

◆ setCharset()

◆ setPlainText()

◆ setText()