KMime::Headers::Base
#include <kmime_headers.h>

Public Types | |
typedef QList< KMime::Headers::Base * > | List |
Public Member Functions | |
Base () | |
virtual | ~Base () |
virtual QByteArray | as7BitString (bool withHeaderType=true) const =0 |
virtual QString | asUnicodeString () const =0 |
virtual void | clear ()=0 |
virtual void | from7BitString (const char *s, size_t len) |
virtual void | from7BitString (const QByteArray &s)=0 |
virtual void | fromUnicodeString (const QString &s, const QByteArray &b)=0 |
bool | is (const char *t) const |
virtual bool | isEmpty () const =0 |
bool | isMimeHeader () const |
QByteArray | rfc2047Charset () const |
void | setRFC2047Charset (const QByteArray &cs) |
virtual const char * | type () const |
Protected Member Functions | |
QByteArray | typeIntro () const |
Detailed Description
Baseclass of all header-classes.
It represents a header-field as described in RFC-822.
Definition at line 103 of file kmime_headers.h.
Member Typedef Documentation
◆ List
typedef QList<KMime::Headers::Base *> KMime::Headers::Base::List |
A vector of headers.
Definition at line 109 of file kmime_headers.h.
Constructor & Destructor Documentation
◆ Base()
KMime::Headers::Base::Base | ( | ) |
Creates an empty header.
Definition at line 93 of file kmime_headers.cpp.
◆ ~Base()
|
virtual |
Destructor.
Definition at line 102 of file kmime_headers.cpp.
Member Function Documentation
◆ as7BitString()
|
pure virtual |
Returns the encoded header.
- Parameters
-
withHeaderType Specifies whether the header-type should be included.
Implemented in KMime::Headers::Lines, KMime::Headers::Newsgroups, KMime::Headers::Date, KMime::Headers::Control, KMime::Headers::ContentDisposition, KMime::Headers::ContentType, KMime::Headers::MailCopiesTo, KMime::Headers::ReturnPath, KMime::Headers::Generics::Parametrized, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::Token, KMime::Headers::Generics::Ident, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::MailboxList, and KMime::Headers::Generics::Unstructured.
◆ asUnicodeString()
|
pure virtual |
Returns the decoded content of the header without the header-type.
- Note
- The return value of this method should only be used when showing an address to the user. It is not guaranteed that fromUnicodeString( asUnicodeString(), ... ) will return the original string.
Implemented in KMime::Headers::Lines, KMime::Headers::Newsgroups, KMime::Headers::MailCopiesTo, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::Structured, and KMime::Headers::Generics::Unstructured.
◆ clear()
|
pure virtual |
Deletes.
Implemented in KMime::Headers::Lines, KMime::Headers::Newsgroups, KMime::Headers::Date, KMime::Headers::Control, KMime::Headers::Generic, KMime::Headers::ContentDisposition, KMime::Headers::ContentType, KMime::Headers::ContentTransferEncoding, KMime::Headers::MailCopiesTo, KMime::Headers::ReturnPath, KMime::Headers::Generics::Parametrized, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::Token, KMime::Headers::Generics::Ident, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::MailboxList, and KMime::Headers::Generics::Unstructured.
◆ from7BitString()
|
virtual |
Parses the given string.
Take care of RFC2047-encoded strings.
- Parameters
-
s The encoded header data.
Reimplemented in KMime::Headers::Generics::Structured.
Definition at line 108 of file kmime_headers.cpp.
◆ fromUnicodeString()
|
pure virtual |
Parses the given string and set the charset.
- Parameters
-
s The header data as unicode string. b The charset preferred for encoding.
Implemented in KMime::Headers::Newsgroups, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::Structured, and KMime::Headers::Generics::Unstructured.
◆ is()
bool KMime::Headers::Base::is | ( | const char * | t | ) | const |
Checks if this header is of type t
.
Definition at line 132 of file kmime_headers.cpp.
◆ isEmpty()
|
pure virtual |
Checks if this header contains any data.
Implemented in KMime::Headers::Lines, KMime::Headers::Newsgroups, KMime::Headers::Date, KMime::Headers::Control, KMime::Headers::Generic, KMime::Headers::ContentDisposition, KMime::Headers::ContentType, KMime::Headers::MailCopiesTo, KMime::Headers::ReturnPath, KMime::Headers::Generics::Parametrized, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::Token, KMime::Headers::Generics::Ident, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::MailboxList, and KMime::Headers::Generics::Unstructured.
◆ isMimeHeader()
bool KMime::Headers::Base::isMimeHeader | ( | ) | const |
Checks if this header is a MIME header.
Definition at line 137 of file kmime_headers.cpp.
◆ rfc2047Charset()
QByteArray KMime::Headers::Base::rfc2047Charset | ( | ) | const |
Returns the charset that is used for RFC2047-encoding.
Definition at line 113 of file kmime_headers.cpp.
◆ setRFC2047Charset()
void KMime::Headers::Base::setRFC2047Charset | ( | const QByteArray & | cs | ) |
Sets the charset for RFC2047-encoding.
- Parameters
-
cs The new charset used for RFC2047 encoding.
Definition at line 122 of file kmime_headers.cpp.
◆ type()
|
virtual |
Returns the type of this header (e.g.
"From").
Reimplemented in KMime::Headers::Generic.
Definition at line 127 of file kmime_headers.cpp.
◆ typeIntro()
|
protected |
Helper method, returns the header prefix including ":".
Definition at line 142 of file kmime_headers.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 03:52:34 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.