KMime::Headers::Control

KMime::Headers::Control Class Reference

#include <kmime_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 (const char *s, size_t len) override
 
void from7BitString (const QByteArray &s) override
 
void fromUnicodeString (const QString &s, const QByteArray &b) override
 
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
 
virtual ~Base ()
 
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 QVector< KMime::Headers::Base * > List
 

Detailed Description

Represents a "Control" header.

See also
RFC 1036, section 3.

Definition at line 1272 of file kmime_headers.h.

Member Function Documentation

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

Returns the encoded header.

Parameters
withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Definition at line 1298 of file kmime_headers.cpp.

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

Deletes.

Implements KMime::Headers::Base.

Definition at line 1317 of file kmime_headers.cpp.

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

Returns the control message type.

Definition at line 1329 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 1339 of file kmime_headers.cpp.

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

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 1324 of file kmime_headers.cpp.

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

Returns the control message parameter.

Definition at line 1334 of file kmime_headers.cpp.

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

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 1351 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 1344 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 3 2020 23:11:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.