KMime::Headers::Control
#include <headers.h>
Public Member Functions | |
QByteArray | as7BitString (bool withHeaderType=true) const 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 (QByteArrayView t) 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::Generics::Structured | |
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.
Member Function Documentation
◆ as7BitString()
|
nodiscardoverridevirtual |
Returns the encoded header.
- Parameters
-
withHeaderType Specifies whether the header-type should be included.
Implements KMime::Headers::Base.
Definition at line 1190 of file headers.cpp.
◆ controlType()
|
nodiscard |
Returns the control message type.
Definition at line 1214 of file headers.cpp.
◆ isCancel()
|
nodiscard |
Returns true if this is a cancel control message.
- See also
- RFC 1036, section 3.1.
Definition at line 1224 of file headers.cpp.
◆ isEmpty()
|
nodiscardoverridevirtual |
Checks if this header contains any data.
Implements KMime::Headers::Base.
Definition at line 1209 of file headers.cpp.
◆ parameter()
|
nodiscard |
Returns the control message parameter.
Definition at line 1219 of file headers.cpp.
◆ parse()
|
overrideprotectedvirtual |
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 1236 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.
- Parameters
-
msgid The message-id of the article that should be canceled.
Definition at line 1229 of file headers.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:18:08 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.