KMime::Headers::Generics::Structured Class Reference

#include <kmime_headers.h>

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

Public Member Functions
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 ()
virtual QByteArray	as7BitString (bool withHeaderType=true) const =0
virtual void	clear ()=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
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 276 of file kmime_headers.h.

Constructor & Destructor Documentation

Structured()

KMime::Headers::Generics::Structured::Structured

(

)

Definition at line 214 of file kmime_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 251 of file kmime_headers.cpp.

from7BitString() [1/2]

void KMime::Headers::Generics::Structured::from7BitString ( const char * s, size_t len )

overridevirtual

Parses the given string.

Take care of RFC2047-encoded strings.

Parameters

s	The encoded header data.

Reimplemented from KMime::Headers::Base.

Definition at line 228 of file kmime_headers.cpp.

from7BitString() [2/2]

void KMime::Headers::Generics::Structured::from7BitString ( const QByteArray & s )

overridevirtual

Implements KMime::Headers::Base.

Definition at line 237 of file kmime_headers.cpp.

fromUnicodeString()

void KMime::Headers::Generics::Structured::fromUnicodeString ( const QString & s, const QByteArray & b )

overridevirtual

Parses the given string and set the charset.

Parameters

s	The header data as unicode string.
b	The charset preferred for encoding.

Implements KMime::Headers::Base.

Definition at line 256 of file kmime_headers.cpp.

parse()

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

protectedpure 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.

Implemented in KMime::Headers::Generics::MailboxList, KMime::Headers::Generics::SingleMailbox, KMime::Headers::Generics::AddressList, KMime::Headers::Generics::Ident, KMime::Headers::Generics::SingleIdent, KMime::Headers::Generics::Token, KMime::Headers::Generics::PhraseList, KMime::Headers::Generics::DotAtom, KMime::Headers::Generics::Parametrized, KMime::Headers::ReturnPath, KMime::Headers::MailCopiesTo, KMime::Headers::ContentTransferEncoding, KMime::Headers::ContentID, KMime::Headers::ContentType, KMime::Headers::ContentDisposition, KMime::Headers::Control, KMime::Headers::Date, KMime::Headers::Newsgroups, and KMime::Headers::Lines.

---

The documentation for this class was generated from the following files:

• kmime_headers.h
• kmime_headers.cpp