KMime::Headers::Generics::Structured

Search for usage in LXR

KMime::Headers::Generics::Structured Class Referenceabstract

#include <headers.h>

Inheritance diagram for KMime::Headers::Generics::Structured:

Public Member Functions

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 ()
 
virtual QByteArray as7BitString (bool withHeaderType=true) const =0
 
virtual void clear ()=0
 
void fromUnicodeString (const QString &s, const QByteArray &b)
 
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

virtual bool parse (const char *&scursor, const char *const send, bool isCRLF=false)=0
 
- 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

Base class for structured header fields.

This is the base class for all structured header fields. It contains parsing methods for all basic token types found in rfc2822.

Parsing

At the basic level, there are tokens & tspecials (rfc2045), atoms & specials, quoted-strings, domain-literals (all rfc822) and encoded-words (rfc2047).

As a special token, we have the comment. It is one of the basic tokens defined in rfc822, but it's parsing relies in part on the basic token parsers (e.g. comments may contain encoded-words). Also, most upper-level parsers (notably those for phrase and dot-atom) choose to ignore any comment when parsing.

Then there are the real composite tokens, which are made up of one or more of the basic tokens (and semantically invisible comments): phrases (rfc822 with rfc2047) and dot-atoms (rfc2822).

This finishes the list of supported token types. Subclasses will provide support for more higher-level tokens, where necessary, using these parsers.

Author
Marc Mutz mutz@.nosp@m.kde..nosp@m.org

Definition at line 280 of file headers.h.

Constructor & Destructor Documentation

◆ Structured()

KMime::Headers::Generics::Structured::Structured ( )

Definition at line 209 of file headers.cpp.

Member Function Documentation

◆ asUnicodeString()

QString KMime::Headers::Generics::Structured::asUnicodeString ( ) const
overridevirtual

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.

Implements KMime::Headers::Base.

Definition at line 233 of file headers.cpp.

◆ from7BitString()

void KMime::Headers::Generics::Structured::from7BitString ( QByteArrayView s)
overridevirtual

Parses the given string.

Take care of RFC2047-encoded strings.

Parameters
sThe encoded header data.

Implements KMime::Headers::Base.

Definition at line 223 of file headers.cpp.

◆ fromUnicodeString() [1/2]

void KMime::Headers::Generics::Structured::fromUnicodeString ( const QString & s)
overridevirtual

Parses the given Unicode representation of the header content.

Parameters
sThe header data as Unicode string.

Implements KMime::Headers::Base.

Definition at line 238 of file headers.cpp.

◆ fromUnicodeString() [2/2]

void KMime::Headers::Base::fromUnicodeString ( const QString & s,
const QByteArray & b )
inline

Definition at line 144 of file headers.h.

◆ parse()

virtual bool KMime::Headers::Generics::Structured::parse ( const char *& scursor,
const char *const send,
bool isCRLF = false )
protectedpure virtual

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 19 2024 11:52:51 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.