• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.4 API Reference
  • KDE Home
  • Contact Us
 

KMIME Library

  • KMime
  • Headers
  • Control
Public Member Functions | Protected Member Functions
KMime::Headers::Control Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Control:
KMime::Headers::Generics::Structured KMime::Headers::Base

List of all members.

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)
- Public Member Functions inherited from KMime::Headers::Generics::Structured
 Structured (Content *p=0)
 Structured (Content *p, const QByteArray &s)
 Structured (Content *p, const QString &s, const QByteArray &cs)
virtual QString asUnicodeString () const
virtual void from7BitString (const QByteArray &s)
virtual void fromUnicodeString (const QString &s, const QByteArray &b)
- Public Member Functions inherited from KMime::Headers::Base
 Base (KMime::Content *parent=0)
virtual ~Base ()
QByteArray defaultCharset () const
bool forceDefaultCharset () const
bool is (const char *t) const
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

Protected Member Functions

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

Detailed Description

Represents a "Control" header.

See also:
RFC 1036, section 3.

Definition at line 1305 of file kmime_headers.h.


Member Function Documentation

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

Returns the encoded header.

Parameters:
withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 1316 of file kmime_headers.cpp.

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

Deletes.

Implements KMime::Headers::Base.

Definition at line 1335 of file kmime_headers.cpp.

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

Returns the control message type.

Definition at line 1347 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 1357 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 1342 of file kmime_headers.cpp.

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

Returns the control message parameter.

Definition at line 1352 of file kmime_headers.cpp.

bool KMime::Headers::Control::parse ( const char *&  scursor,
const char *const  send,
bool  isCRLF = false 
)
protectedvirtual

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

Parameters:
scursorPointer to the start of the data still to parse.
sendPointer to the end of the data.
isCRLFtrue if input string is terminated with a CRLF.

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

Definition at line 1369 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:
msgidThe message-id of the article that should be canceled.

Definition at line 1362 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
  • kmime_headers.h
  • kmime_headers.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Mon Jun 24 2013 20:29:26 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KMIME Library

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

kdepimlibs-4.10.4 API Reference

Skip menu "kdepimlibs-4.10.4 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal