Base class for headers that deal with (possibly multiple) addresses, allowing groups. More...
#include <kmime_headers.h>

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:
-
mbox A Mailbox object specifying the address.
Definition at line 583 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 591 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 603 of file kmime_headers.cpp.
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 539 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 567 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 572 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 614 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 560 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 578 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 636 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 647 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 <address>".
These are unicode strings without any transport encoding, ie. they are only suitable for displaying.
Definition at line 625 of file kmime_headers.cpp.
The documentation for this class was generated from the following files: