• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KMIME Library

KMime::Headers::Generics::AddressList

KMime::Headers::Generics::AddressList Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Generics::AddressList:

Inheritance graph
[legend]

List of all members.


Detailed Description

Base class for headers that deal with (possibly multiple) addresses, allowing groups.

Note: Groups are parsed but not represented in the API yet. All addresses in groups are listed as if they would not be part of a group.

Todo:
Add API for groups?
See also:
RFC 2822, section 3.4

Definition at line 473 of file kmime_headers.h.


Public Member Functions

virtual QByteArray as7BitString (bool withHeaderType=true) const
virtual void fromUnicodeString (const QString &s, const QByteArray &b)
virtual QString asUnicodeString () const
virtual void clear ()
virtual bool isEmpty () const
void addAddress (const Types::Mailbox &mbox)
void addAddress (const QByteArray &address, const QString &displayName=QString())
QList< QByteArray > addresses () const
QStringList displayNames () const
QStringList prettyAddresses () const
Types::Mailbox::List mailboxes () const

Protected Member Functions

bool parse (const char *&scursor, const char *const send, bool isCRLF=false)

Member Function Documentation

QByteArray KMime::Headers::Generics::AddressList::as7BitString ( bool  withHeaderType = true  )  const [virtual]

Returns the encoded header.

Parameters:
withHeaderType Specifies whether the header-type should be included.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 513 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::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 534 of file kmime_headers.cpp.

QString KMime::Headers::Generics::AddressList::asUnicodeString (  )  const [virtual]

Returns the decoded content of the header without the header-type.

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

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 541 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::clear (  )  [virtual]

Deletes.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 546 of file kmime_headers.cpp.

bool KMime::Headers::Generics::AddressList::isEmpty (  )  const [virtual]

Checks if this header contains any data.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 552 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::addAddress ( const Types::Mailbox &  mbox  ) 

Adds an address to this header.

Parameters:
mbox A Mailbox object specifying the address.

Definition at line 557 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::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 565 of file kmime_headers.cpp.

QList< QByteArray > KMime::Headers::Generics::AddressList::addresses (  )  const

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

Definition at line 577 of file kmime_headers.cpp.

QStringList KMime::Headers::Generics::AddressList::displayNames (  )  const

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

An empty entry is added for addresses that don't have a display name.

Definition at line 588 of file kmime_headers.cpp.

QStringList KMime::Headers::Generics::AddressList::prettyAddresses (  )  const

Returns a list of assembled display name / address strings of the following form: "Display Name &lt;address&gt;".

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

Definition at line 599 of file kmime_headers.cpp.

Types::Mailbox::List KMime::Headers::Generics::AddressList::mailboxes (  )  const

Returns a list of mailboxes listed in this header.

Definition at line 610 of file kmime_headers.cpp.

bool KMime::Headers::Generics::AddressList::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.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 621 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
  • kmime_headers.h
  • kmime_headers.cpp

KMIME Library

Skip menu "KMIME Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal