• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.3 API Reference
  • KDE Home
  • Contact Us
 

KMIME Library

  • KMime
  • Headers
  • Generics
  • AddressList
Public Member Functions | Protected Member Functions
KMime::Headers::Generics::AddressList Class Reference

#include <kmime_headers.h>

Inheritance diagram for KMime::Headers::Generics::AddressList:
Inheritance graph
[legend]

List of all members.

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

Protected Member Functions

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

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 484 of file kmime_headers.h.


Member Function Documentation

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

Adds an address to this header.

Parameters:
mboxA Mailbox object specifying the address.

Definition at line 584 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:
addressThe actual email address, with or without angle brackets.
displayNameAn optional name associated with the address.

Definition at line 592 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 604 of file kmime_headers.cpp.

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

Returns the encoded header.

Parameters:
withHeaderTypeSpecifies whether the header-type should be included.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 540 of file kmime_headers.cpp.

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

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 568 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 573 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 615 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:
sThe header data as unicode string.
bThe charset preferred for encoding.

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

Definition at line 561 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 579 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 637 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:
scursorPointer to the start of the data still to parse.
sendPointer to the end of the data.
isCRLFtrue if input string is terminated with a CRLF.

Implements KMime::Headers::Generics::Structured.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 648 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 626 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
  • kmime_headers.h
  • kmime_headers.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:17:30 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KMIME Library

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

kdepimlibs-4.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal