KMime::Headers::Generics::AddressList

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

#include <kmime_headers.h>

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

Public Member Functions

void addAddress (const Types::Mailbox &mbox)
 
void addAddress (const QByteArray &address, const QString &displayName=QString())
 
QVector< QByteArrayaddresses () const
 
QByteArray as7BitString (bool withHeaderType=true) const override
 
QString asUnicodeString () const override
 
void clear () override
 
QStringList displayNames () const
 
QString displayString () const
 
void fromUnicodeString (const QString &s, const QByteArray &b) override
 
bool isEmpty () const override
 
Types::Mailbox::List mailboxes () const
 
- Public Member Functions inherited from KMime::Headers::Generics::Structured
void from7BitString (const char *s, size_t len) override
 
void from7BitString (const QByteArray &s) override
 
- Public Member Functions inherited from KMime::Headers::Base
 Base ()
 
virtual ~Base ()
 
bool is (const char *t) const
 
bool isMimeHeader () const
 
QByteArray rfc2047Charset () const
 
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) override
 
- Protected Member Functions inherited from KMime::Headers::Base
QByteArray typeIntro () const
 

Additional Inherited Members

- Public Types inherited from KMime::Headers::Base
typedef QVector< KMime::Headers::Base * > List
 

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 444 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 545 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 553 of file kmime_headers.cpp.

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

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

Definition at line 565 of file kmime_headers.cpp.

QByteArray KMime::Headers::Generics::AddressList::as7BitString ( bool  withHeaderType = true) const
overridevirtual

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 492 of file kmime_headers.cpp.

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

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

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 521 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::clear ( )
overridevirtual

Deletes.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

Definition at line 534 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.

The address is added for addresses that don't have a display name.

Definition at line 576 of file kmime_headers.cpp.

QString KMime::Headers::Generics::AddressList::displayString ( ) const

Returns a single string for user-facing display of this address list.

This is equivalent to displayNames().join(", ").

Since
5.14

Definition at line 592 of file kmime_headers.cpp.

void KMime::Headers::Generics::AddressList::fromUnicodeString ( const QString s,
const QByteArray b 
)
overridevirtual

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 514 of file kmime_headers.cpp.

bool KMime::Headers::Generics::AddressList::isEmpty ( ) const
overridevirtual

Checks if this header contains any data.

Implements KMime::Headers::Base.

Reimplemented in KMime::Headers::MailCopiesTo.

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

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

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 609 of file kmime_headers.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Jun 2 2020 23:06:55 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.