KMime::Headers::Control Class Reference
Represents a "Control" header. More...
#include <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) |
Detailed Description
Represents a "Control" header.
- See also:
- RFC 1036, section 3.
Definition at line 1303 of file kmime_headers.h.
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 1275 of file kmime_headers.cpp.
| void KMime::Headers::Control::clear | ( | ) | [virtual] |
| QByteArray KMime::Headers::Control::controlType | ( | ) | const |
Returns the control message type.
Definition at line 1306 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 1316 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 1301 of file kmime_headers.cpp.
| QByteArray KMime::Headers::Control::parameter | ( | ) | const |
Returns the control message parameter.
Definition at line 1311 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 1328 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 1321 of file kmime_headers.cpp.
The documentation for this class was generated from the following files:
