Public Types | Public Member Functions | List of all members
KMail::Interface::BodyPart Class Referenceabstract

#include <bodypart.h>

Inheritance diagram for KMail::Interface::BodyPart:
KMail::PartNodeBodyPart

Public Types

enum  Display { None , AsIcon , Inline }
 

Public Member Functions

virtual TQString makeLink (const TQString &path) const =0
 
virtual TQString asText () const =0
 
virtual TQByteArray asBinary () const =0
 
virtual TQString contentTypeParameter (const char *parameter) const =0
 
virtual TQString contentDescription () const =0
 
virtual TQString contentDispositionParameter (const char *parameter) const =0
 
virtual bool hasCompleteBody () const =0
 
virtual BodyPartMemento * memento () const =0
 
virtual void setBodyPartMemento (BodyPartMemento *)=0
 
virtual Display defaultDisplay () const =0
 

Detailed Description

interface of message body parts.

Definition at line 75 of file bodypart.h.

Member Function Documentation

◆ asBinary()

virtual TQByteArray KMail::Interface::BodyPart::asBinary ( ) const
pure virtual
Returns
the decoded (CTE undone) content of the body part, or a null array if this body part instance is of type text.

Implemented in KMail::PartNodeBodyPart.

◆ asText()

virtual TQString KMail::Interface::BodyPart::asText ( ) const
pure virtual
Returns
the decoded (CTE, canonicalisation, and charset encoding undone) text contained in the body part, or TQString(), it the body part is not of type "text".

Implemented in KMail::PartNodeBodyPart.

◆ contentDescription()

virtual TQString KMail::Interface::BodyPart::contentDescription ( ) const
pure virtual
Returns
the content of the content-description header field, or TQString() if that header is not present in this body part. RFC 2047 encoding is decoded first.

Implemented in KMail::PartNodeBodyPart.

◆ contentDispositionParameter()

virtual TQString KMail::Interface::BodyPart::contentDispositionParameter ( const char *  parameter) const
pure virtual
Returns
the value of the content-disposition header field parameter with name parameter, or TQString() if that parameter is not present in the body's content-disposition header field. RFC 2231 encoding is removed first.

The notes made for contentTypeParameter() above apply here as well.

Implemented in KMail::PartNodeBodyPart.

◆ contentTypeParameter()

virtual TQString KMail::Interface::BodyPart::contentTypeParameter ( const char *  parameter) const
pure virtual
Returns
the value of the content-type header field parameter with name parameter, or TQString(), if that that parameter is not present in the body's content-type header field. RFC 2231 encoding is removed first.

Note that this method will suppress queries to certain standard parameters (most notably "charset") to keep plugins decent.

Note2 that this method preserves the case of the parameter value returned. So, if the parameter you want to use defines the value to be case-insensitive (such as the smime-type parameter), you need to make sure you do the casemap yourself before comparing to a reference value.

Implemented in KMail::PartNodeBodyPart.

◆ defaultDisplay()

virtual Display KMail::Interface::BodyPart::defaultDisplay ( ) const
pure virtual
Returns
whether this body part should be displayed iconic or inline

Implemented in KMail::PartNodeBodyPart.

◆ hasCompleteBody()

virtual bool KMail::Interface::BodyPart::hasCompleteBody ( ) const
pure virtual
Returns
whether this part already has it's complete body fetched e.g. from an IMAP server.

Implemented in KMail::PartNodeBodyPart.

◆ makeLink()

virtual TQString KMail::Interface::BodyPart::makeLink ( const TQString &  path) const
pure virtual
Returns
a string respresentation of an URL that can be used to invoke a BodyPartURLHandler for this body part.

Implemented in KMail::PartNodeBodyPart.

◆ memento()

virtual BodyPartMemento* KMail::Interface::BodyPart::memento ( ) const
pure virtual
Returns
the BodyPartMemento set for this part, or null, if none is set.

Implemented in KMail::PartNodeBodyPart.

◆ setBodyPartMemento()

virtual void KMail::Interface::BodyPart::setBodyPartMemento ( BodyPartMemento *  )
pure virtual
Returns
register an implementation of the BodyPartMemento interface as a status object with this part.

Implemented in KMail::PartNodeBodyPart.

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