KMime::Headers::Generics::MailboxList Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Generics::MailboxList:

Public Member Functions
void	addAddress (const Types::Mailbox &mbox)
void	addAddress (const QByteArray &address, const QString &displayName=QString())
QList< QByteArray >	addresses () const
virtual QByteArray	as7BitString (bool withHeaderType=true) const
virtual QString	asUnicodeString () const
virtual void	clear ()
QStringList	displayNames () const
virtual void	fromUnicodeString (const QString &s, const QByteArray &b)
virtual bool	isEmpty () const
Types::Mailbox::List	mailboxes () const
QStringList	prettyAddresses () const
Public Member Functions inherited from KMime::Headers::Generics::Address
	Address (Content *p=0)
	Address (Content *p, const QByteArray &s)
	Address (Content *p, const QString &s, const QByteArray &cs)
Public Member Functions inherited from KMime::Headers::Generics::Structured
	Structured (Content *p=0)
	Structured (Content *p, const QByteArray &s)
	Structured (Content *p, const QString &s, const QByteArray &cs)
virtual void	from7BitString (const QByteArray &s)
Public Member Functions inherited from KMime::Headers::Base
	Base (KMime::Content *parent=0)
virtual	~Base ()
QByteArray	defaultCharset () const
bool	forceDefaultCharset () const
bool	is (const char *t) const
bool	isMimeHeader () const
bool	isXHeader () const
KMime::Content *	parent () const
QByteArray	rfc2047Charset () const
void	setParent (KMime::Content *parent)
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)
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 headers that deal with (possibly multiple) addresses, but don't allow groups.

See also

RFC 2822, section 3.4

Definition at line 389 of file kmime_headers.h.

Member Function Documentation

void KMime::Headers::Generics::MailboxList::addAddress

(

const Types::Mailbox &

mbox

)

Adds an address to this header.

Parameters

mbox	A Mailbox object specifying the address.

Definition at line 432 of file kmime_headers.cpp.

void KMime::Headers::Generics::MailboxList::addAddress	(	const QByteArray &	address,
		const QString &	displayName = QString()
	)

Adds an address to this header.

Parameters

address	The actual email address, with or without angle brackets.
displayName	An optional name associated with the address.

Definition at line 438 of file kmime_headers.cpp.

QList< QByteArray > KMime::Headers::Generics::MailboxList::addresses

(

)

const

Returns a list of all addresses in this header, regardless of groups.

Definition at line 448 of file kmime_headers.cpp.

Address QByteArray KMime::Headers::Generics::MailboxList::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 390 of file kmime_headers.cpp.

QString KMime::Headers::Generics::MailboxList::asUnicodeString ( ) const

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.

Reimplemented from KMime::Headers::Generics::Structured.

Definition at line 416 of file kmime_headers.cpp.

void KMime::Headers::Generics::MailboxList::clear ( )

virtual

Deletes.

Implements KMime::Headers::Base.

Definition at line 421 of file kmime_headers.cpp.

QStringList KMime::Headers::Generics::MailboxList::displayNames

(

)

const

Returns a list of all display names associated with the addresses in this header.

An empty entry is added for addresses that do not have a display name.

Definition at line 457 of file kmime_headers.cpp.

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

virtual

Parses the given string and set the charset.

Parameters

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

Reimplemented from KMime::Headers::Generics::Structured.

Definition at line 409 of file kmime_headers.cpp.

bool KMime::Headers::Generics::MailboxList::isEmpty ( ) const

virtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Definition at line 427 of file kmime_headers.cpp.

Types::Mailbox::List KMime::Headers::Generics::MailboxList::mailboxes

(

)

const

Returns a list of mailboxes listed in this header.

Definition at line 475 of file kmime_headers.cpp.

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

protectedvirtual

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.

Reimplemented in KMime::Headers::Generics::SingleMailbox.

Definition at line 480 of file kmime_headers.cpp.

QStringList KMime::Headers::Generics::MailboxList::prettyAddresses

(

)

const

Returns a list of assembled display name / address strings of the following form: "Display Name <address>".

These are unicode strings without any transport encoding, ie. they are only suitable for displaying.

Definition at line 466 of file kmime_headers.cpp.

---

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

• kmime_headers.h
• kmime_headers.cpp