attachment Class Reference

#include <attachment.hpp>

Inheritance diagram for attachment:

Collaboration diagram for attachment:

Public Member Functions
virtual	~attachment ()
virtual const mediaType	getType () const =0
virtual const text	getDescription () const =0
virtual const word	getName () const =0
virtual const shared_ptr< const contentHandler >	getData () const =0
virtual const encoding	getEncoding () const =0
virtual shared_ptr< const object >	getPart () const =0
virtual shared_ptr< const header >	getHeader () const =0

Protected Member Functions
	attachment ()
virtual void	generateIn (shared_ptr< bodyPart > parent) const =0
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Base class for all types of attachment.

Constructor & Destructor Documentation

attachment()

attachment ( )

protected

Referenced by defaultAttachment::defaultAttachment().

~attachment()

virtual ~attachment ( )

virtual

Member Function Documentation

generateIn()

virtual void generateIn ( shared_ptr< bodyPart > parent ) const

protectedpure virtual

Generate the attachment in the specified body part.

Parameters

parent

body part in which to generate the attachment

getData()

virtual const shared_ptr< const contentHandler > getData ( ) const

pure virtual

Return the data contained in this attachment.

Returns

attachment data

Implemented in defaultAttachment.

getDescription()

virtual const text getDescription ( ) const

pure virtual

Return the description of this attachment.

Returns

attachment description, or an empty text if no description is available

Implemented in defaultAttachment.

getEncoding()

virtual const encoding getEncoding ( ) const

pure virtual

Return the encoding used for this attachment.

Returns

attachment data encoding

Implemented in defaultAttachment.

getHeader()

virtual shared_ptr< const header > getHeader ( ) const

pure virtual

Return the header of the attachment part.

Returns

attachment part header or NULL if the attachment is not attached to a part

Implemented in defaultAttachment.

getName()

virtual const word getName ( ) const

pure virtual

Return the (file) name of this attachment.

Returns

attachment name, or an empty word if no name is available

Implemented in defaultAttachment.

getPart()

virtual shared_ptr< const object > getPart ( ) const

pure virtual

Return the part in which the attachment has been found.

This can be a vmime::bodyPart or a vmime::net::part object.

Returns

attachment part or NULL if the attachment is not attached to a part

Implemented in defaultAttachment.

getType()

virtual const mediaType getType ( ) const

pure virtual

Return the media type of this attachment.

Returns

content type of the attachment

Implemented in defaultAttachment.

---

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

• attachment.hpp