attachment Class Reference
Base class for all types of attachment. More...
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 ref< const contentHandler > | getData () const =0 |
| virtual const encoding | getEncoding () const =0 |
| virtual ref< const object > | getPart () const =0 |
| virtual ref< const header > | getHeader () const =0 |
Protected Member Functions | |
| attachment () | |
| virtual void | generateIn (ref< bodyPart > parent) const =0 |
Detailed Description
Base class for all types of attachment.
Constructor & Destructor Documentation
| attachment | ( | ) | [protected] |
| virtual ~attachment | ( | ) | [virtual] |
Member Function Documentation
| virtual void generateIn | ( | ref< bodyPart > | parent | ) | const [protected, pure virtual] |
Generate the attachment in the specified body part.
- Parameters:
-
parent body part in which to generate the attachment
| virtual const ref<const contentHandler> getData | ( | ) | const [pure virtual] |
Return the data contained in this attachment.
- Returns:
- attachment data
Implemented in defaultAttachment.
| 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.
| virtual const encoding getEncoding | ( | ) | const [pure virtual] |
Return the encoding used for this attachment.
- Returns:
- attachment data encoding
Implemented in defaultAttachment.
| virtual ref<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.
| 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.
| virtual ref<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.
| 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:
