• 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::Control

KMime::Headers::Control Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Control:

Inheritance graph
[legend]

List of all members.


Detailed Description

Represents a "Control" header.

See also:
RFC 1036, section 3.

Definition at line 1265 of file kmime_headers.h.


Public Member Functions

virtual QByteArray as7BitString (bool withHeaderType=true) const
virtual void clear ()
QByteArray controlType () const
bool isCancel () const
virtual bool isEmpty () const
QByteArray parameter () const
void setCancel (const QByteArray &msgid)

Protected Member Functions

bool parse (const char *&scursor, const char *const send, bool isCRLF=false)

Member Function Documentation

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

Returns the encoded header.

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

Implements KMime::Headers::Base.

Definition at line 1248 of file kmime_headers.cpp.

void KMime::Headers::Control::clear (  )  [virtual]

Deletes.

Implements KMime::Headers::Base.

Definition at line 1267 of file kmime_headers.cpp.

QByteArray KMime::Headers::Control::controlType (  )  const

Returns the control message type.

Definition at line 1279 of file kmime_headers.cpp.

bool KMime::Headers::Control::isCancel (  )  const

Returns true if this is a cancel control message.

See also:
RFC 1036, section 3.1.

Definition at line 1289 of file kmime_headers.cpp.

bool KMime::Headers::Control::isEmpty (  )  const [virtual]

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 1274 of file kmime_headers.cpp.

QByteArray KMime::Headers::Control::parameter (  )  const

Returns the control message parameter.

Definition at line 1284 of file kmime_headers.cpp.

bool KMime::Headers::Control::parse ( const char *&  scursor,
const char *const   send,
bool  isCRLF = false 
) [protected, virtual]

This method parses the raw header and needs to be implemented in every sub-class.

Parameters:
scursor Pointer to the start of the data still to parse.
send Pointer to the end of the data.
isCRLF true if input string is terminated with a CRLF.

Implements KMime::Headers::Generics::Structured.

Definition at line 1301 of file kmime_headers.cpp.

void KMime::Headers::Control::setCancel ( const QByteArray &  msgid  ) 

Changes this header into a cancel control message for the given message-id.

Parameters:
msgid The message-id of the article that should be canceled.

Definition at line 1294 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.4
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