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

KMIME Library

KMime::Headers::Base

KMime::Headers::Base Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Base:

Inheritance graph
[legend]

List of all members.


Detailed Description

Baseclass of all header-classes.

It represents a header-field as described in RFC-822.

Definition at line 117 of file kmime_headers.h.


Public Types

typedef QList
< KMime::Headers::Base * > 
List

Public Member Functions

virtual QByteArray as7BitString (bool withHeaderType=true) const =0
virtual QString asUnicodeString () const =0
 Base (KMime::Content *parent=0)
virtual void clear ()=0
QByteArray defaultCharset () const
bool forceDefaultCharset () const
virtual void from7BitString (const QByteArray &s)=0
virtual void fromUnicodeString (const QString &s, const QByteArray &b)=0
bool is (const char *t) const
virtual bool isEmpty () const =0
bool isMimeHeader () const
bool isXHeader () const
KMime::Content * parent () const
QByteArray rfc2047Charset () const
void setParent (KMime::Content *parent)
void setRFC2047Charset (const QByteArray &cs)
virtual const char * type () const
virtual ~Base ()

Protected Member Functions

QByteArray typeIntro () const

Member Typedef Documentation

typedef QList<KMime::Headers::Base*> KMime::Headers::Base::List

A list of headers.

Definition at line 123 of file kmime_headers.h.


Constructor & Destructor Documentation

KMime::Headers::Base::Base ( KMime::Content *  parent = 0  )  [explicit]

Creates an empty header with a parent-content.

Definition at line 122 of file kmime_headers.cpp.

KMime::Headers::Base::~Base (  )  [virtual]

Destructor.

Definition at line 136 of file kmime_headers.cpp.


Member Function Documentation

virtual QByteArray KMime::Headers::Base::as7BitString ( bool  withHeaderType = true  )  const [pure virtual]

Returns the encoded header.

Parameters:
withHeaderType Specifies whether the header-type should be included.

Implemented in KMime::Headers::Generics::Unstructured, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::Ident, KMime::Headers::Generics::Token, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::Parametrized, KMime::Headers::ReturnPath, KMime::Headers::MailCopiesTo, KMime::Headers::ContentType, KMime::Headers::ContentDisposition, KMime::Headers::Control, KMime::Headers::Date, KMime::Headers::Newsgroups, and KMime::Headers::Lines.

virtual QString KMime::Headers::Base::asUnicodeString (  )  const [pure virtual]

Returns the decoded content of the header without the header-type.

Implemented in KMime::Headers::Generics::Unstructured, KMime::Headers::Generics::Structured, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::DotAtom, KMime::Headers::MailCopiesTo, KMime::Headers::Newsgroups, and KMime::Headers::Lines.

virtual void KMime::Headers::Base::clear (  )  [pure virtual]

Deletes.

Implemented in KMime::Headers::Generics::Unstructured, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::Ident, KMime::Headers::Generics::Token, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::Parametrized, KMime::Headers::ReturnPath, KMime::Headers::MailCopiesTo, KMime::Headers::ContentTransferEncoding, KMime::Headers::ContentType, KMime::Headers::ContentDisposition, KMime::Headers::Generic, KMime::Headers::Control, KMime::Headers::Date, KMime::Headers::Newsgroups, and KMime::Headers::Lines.

QByteArray KMime::Headers::Base::defaultCharset (  )  const

Returns the default charset.

Definition at line 170 of file kmime_headers.cpp.

bool KMime::Headers::Base::forceDefaultCharset (  )  const

Returns if the default charset is mandatory.

Definition at line 165 of file kmime_headers.cpp.

virtual void KMime::Headers::Base::from7BitString ( const QByteArray &  s  )  [pure virtual]

Parses the given string.

Take care of RFC2047-encoded strings.

Parameters:
s The encoded header data.

Implemented in KMime::Headers::Generics::Unstructured, and KMime::Headers::Generics::Structured.

virtual void KMime::Headers::Base::fromUnicodeString ( const QString &  s,
const QByteArray &  b 
) [pure virtual]

Parses the given string and set the charset.

Parameters:
s The header data as unicode string.
b The charset preferred for encoding.

Implemented in KMime::Headers::Generics::Unstructured, KMime::Headers::Generics::Structured, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::AddressList, and KMime::Headers::Newsgroups.

bool KMime::Headers::Base::is ( const char *  t  )  const

Checks if this header is of type t.

Definition at line 180 of file kmime_headers.cpp.

virtual bool KMime::Headers::Base::isEmpty (  )  const [pure virtual]

Checks if this header contains any data.

Implemented in KMime::Headers::Generics::Unstructured, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::Ident, KMime::Headers::Generics::Token, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::Parametrized, KMime::Headers::ReturnPath, KMime::Headers::MailCopiesTo, KMime::Headers::ContentType, KMime::Headers::ContentDisposition, KMime::Headers::Generic, KMime::Headers::Control, KMime::Headers::Date, KMime::Headers::Newsgroups, and KMime::Headers::Lines.

bool KMime::Headers::Base::isMimeHeader (  )  const

Checks if this header is a MIME header.

Definition at line 185 of file kmime_headers.cpp.

bool KMime::Headers::Base::isXHeader (  )  const

Checks if this header is a X-Header.

Definition at line 190 of file kmime_headers.cpp.

KMime::Content * KMime::Headers::Base::parent (  )  const

Returns the parent of this header.

Definition at line 141 of file kmime_headers.cpp.

QByteArray KMime::Headers::Base::rfc2047Charset (  )  const

Returns the charset that is used for RFC2047-encoding.

Definition at line 151 of file kmime_headers.cpp.

void KMime::Headers::Base::setParent ( KMime::Content *  parent  ) 

Sets the parent for this header to parent.

Definition at line 146 of file kmime_headers.cpp.

void KMime::Headers::Base::setRFC2047Charset ( const QByteArray &  cs  ) 

Sets the charset for RFC2047-encoding.

Parameters:
cs The new charset used for RFC2047 encoding.

Definition at line 160 of file kmime_headers.cpp.

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

Returns the type of this header (e.g.

"From").

Reimplemented in KMime::Headers::Generic.

Definition at line 175 of file kmime_headers.cpp.

QByteArray KMime::Headers::Base::typeIntro (  )  const [protected]

Helper method, returns the header prefix including ":".

Definition at line 195 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
  • kmime_headers.h
  • kmime_headers.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
  • 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