Search for usage in LXR

KMime::Headers::Control Class Reference

#include <headers.h>

Inheritance diagram for KMime::Headers::Control:

Public Member Functions

QByteArray as7BitString (bool withHeaderType=true) const override
void clear () override
QByteArray controlType () const
bool isCancel () const
bool isEmpty () const override
QByteArray parameter () const
void setCancel (const QByteArray &msgid)
- Public Member Functions inherited from KMime::Headers::Generics::Structured
QString asUnicodeString () const override
void from7BitString (QByteArrayView s) override
void fromUnicodeString (const QString &s) override
void fromUnicodeString (const QString &s, const QByteArray &b)
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
virtual ~Base ()
void fromUnicodeString (const QString &s, const QByteArray &b)
bool is (const char *t) const
bool isMimeHeader () const
QByteArray rfc2047Charset () const
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) override
- Protected Member Functions inherited from KMime::Headers::Base
QByteArray typeIntro () const

Additional Inherited Members

- Public Types inherited from KMime::Headers::Base
typedef QList< KMime::Headers::Base * > List

Detailed Description

Represents a "Control" header.

See also
RFC 1036, section 3.

Definition at line 1267 of file headers.h.

Member Function Documentation

◆ as7BitString()

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

Returns the encoded header.

withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 1223 of file headers.cpp.

◆ clear()

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


Implements KMime::Headers::Base.

Definition at line 1242 of file headers.cpp.

◆ controlType()

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

Returns the control message type.

Definition at line 1254 of file headers.cpp.

◆ isCancel()

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 1264 of file headers.cpp.

◆ isEmpty()

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

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 1249 of file headers.cpp.

◆ parameter()

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

Returns the control message parameter.

Definition at line 1259 of file headers.cpp.

◆ parse()

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

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

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 1276 of file headers.cpp.

◆ setCancel()

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

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

msgidThe message-id of the article that should be canceled.

Definition at line 1269 of file headers.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 12:03:39 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.