• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KMIME Library

KMime::Message

KMime::Message Class Reference

#include <kmime_message.h>

Inheritance diagram for KMime::Message:

Inheritance graph
[legend]

List of all members.


Detailed Description

Represents a (email) message.

Definition at line 38 of file kmime_message.h.


Public Types

typedef QList< KMime::Message * > List

Public Member Functions

virtual KMime::Headers::Bcc * bcc (bool create=true)
virtual KMime::Headers::Cc * cc (bool create=true)
virtual void clear ()
virtual KMime::Headers::Date * date (bool create=true)
virtual KMime::Headers::From * from (bool create=true)
virtual KMime::Headers::Base * getHeaderByType (const char *type)
virtual KMime::Headers::Base * headerByType (const char *type)
virtual KMime::Headers::InReplyTo * inReplyTo (bool create=true)
virtual bool isTopLevel () const
Content * mainBodyPart (const QByteArray &type=QByteArray())
 Message ()
virtual KMime::Headers::MessageID * messageID (bool create=true)
virtual
KMime::Headers::Organization * 
organization (bool create=true)
virtual void parse ()
virtual
KMime::Headers::References * 
references (bool create=true)
virtual bool removeHeader (const char *type)
virtual KMime::Headers::ReplyTo * replyTo (bool create=true)
virtual KMime::Headers::Sender * sender (bool create=true)
virtual void setHeader (KMime::Headers::Base *h)
virtual KMime::Headers::Subject * subject (bool create=true)
virtual KMime::Headers::To * to (bool create=true)
virtual KMime::Headers::UserAgent * userAgent (bool create=true)

Protected Member Functions

virtual QByteArray assembleHeaders ()

Constructor & Destructor Documentation

KMime::Message::Message (  ) 

Constructor.

Creates an empty message.

Definition at line 32 of file kmime_message.cpp.


Member Function Documentation

QByteArray KMime::Message::assembleHeaders (  )  [protected, virtual]

Reimplement this method if you need to assemble additional headers in a derived class.

Don't forget to call the implementation of the base class.

Returns:
The raw, assembled headers.

Reimplemented from KMime::Content.

Definition at line 52 of file kmime_message.cpp.

void KMime::Message::clear (  )  [virtual]

Clears the complete message and deletes all sub-Contents.

Reimplemented from KMime::Content.

Definition at line 128 of file kmime_message.cpp.

Headers::Base * KMime::Message::getHeaderByType ( const char *  type  )  [virtual]

Deprecated:
Use headerByType( const char * )

Reimplemented from KMime::Content.

Definition at line 136 of file kmime_message.cpp.

Headers::Base * KMime::Message::headerByType ( const char *  type  )  [virtual]

Since:
4.2

Reimplemented from KMime::Content.

Definition at line 141 of file kmime_message.cpp.

bool KMime::Message::isTopLevel (  )  const [virtual]

Returns true if this is the top-level node in the MIME tree, ie.

if this is actually a message or news article.

Reimplemented from KMime::Content.

Definition at line 210 of file kmime_message.cpp.

Content * KMime::Message::mainBodyPart ( const QByteArray &  type = QByteArray()  ) 

Returns the first main body part of a given type, taking multipart/mixed and multipart/alternative nodes into consideration.

Eg. bodyPart("text/html") will return a html content object if that is provided in a multipart/alternative node, but not if it's the non-first child node of a multipart/mixed node (ie. an attachment).

Parameters:
type The mimetype of the body part, if not given, the first body part will be returned, regardless of it's type.

Definition at line 215 of file kmime_message.cpp.

virtual KMime::Headers::MessageID* KMime::Message::messageID ( bool  create = true  )  [virtual]

Returns the message MessageID.

void KMime::Message::parse (  )  [virtual]

Parses the Contents, splitting into multiple sub-Contents.

Reimplemented from KMime::Content.

Definition at line 39 of file kmime_message.cpp.


The documentation for this class was generated from the following files:
  • kmime_message.h
  • kmime_message.cpp

KMIME Library

Skip menu "KMIME Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal