KMime::Headers::Generics::MailboxList
#include <headers.h>
Public Member Functions | |
void | addAddress (const QByteArray &address, const QString &displayName=QString()) |
void | addAddress (const Types::Mailbox &mbox) |
QList< QByteArray > | addresses () const |
QByteArray | as7BitString (bool withHeaderType=true) const override |
QString | asUnicodeString () const override |
QStringList | displayNames () const |
QString | displayString () const |
void | fromUnicodeString (const QString &s) override |
void | fromUnicodeString (const QString &s, const QByteArray &b) |
bool | isEmpty () const override |
Types::Mailbox::List | mailboxes () const |
void | setMailboxes (const Types::Mailbox::List &mailboxes) |
Public Member Functions inherited from KMime::Headers::Generics::Structured | |
QString | asUnicodeString () const override |
void | from7BitString (QByteArrayView s) override |
void | fromUnicodeString (const QString &s) override |
void | fromUnicodeString (const QString &s, const QByteArray &b) |
Public Member Functions inherited from KMime::Headers::Base | |
Base () | |
virtual | ~Base () |
void | fromUnicodeString (const QString &s, const QByteArray &b) |
bool | is (QByteArrayView t) 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::Generics::Structured | |
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
Member Function Documentation
◆ addAddress() [1/2]
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 295 of file headers.cpp.
◆ addAddress() [2/2]
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 289 of file headers.cpp.
◆ addresses()
|
nodiscard |
Returns a list of all addresses in this header, regardless of groups.
Definition at line 305 of file headers.cpp.
◆ as7BitString()
|
nodiscardoverridevirtual |
Returns the encoded header.
- Parameters
-
withHeaderType Specifies whether the header-type should be included.
Implements KMime::Headers::Base.
Definition at line 253 of file headers.cpp.
◆ asUnicodeString()
|
nodiscardoverridevirtual |
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.
Implements KMime::Headers::Base.
Definition at line 278 of file headers.cpp.
◆ displayNames()
|
nodiscard |
Returns a list of all display names associated with the addresses in this header.
The address is added for addresses that do not have a display name.
Definition at line 315 of file headers.cpp.
◆ displayString()
|
nodiscard |
Returns a single string for user-facing display of this mailbox list.
This is equivalent to displayNames().join(", ").
- Since
- 5.14
Definition at line 330 of file headers.cpp.
◆ fromUnicodeString() [1/2]
|
overridevirtual |
Parses the given Unicode representation of the header content.
- Parameters
-
s The header data as Unicode string.
Implements KMime::Headers::Base.
Definition at line 272 of file headers.cpp.
◆ fromUnicodeString() [2/2]
|
inline |
◆ isEmpty()
|
nodiscardoverridevirtual |
Checks if this header contains any data.
Implements KMime::Headers::Base.
Definition at line 284 of file headers.cpp.
◆ mailboxes()
|
nodiscard |
Returns a list of mailboxes listed in this header.
Definition at line 344 of file headers.cpp.
◆ parse()
|
overrideprotectedvirtual |
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.
Definition at line 355 of file headers.cpp.
◆ setMailboxes()
void KMime::Headers::Generics::MailboxList::setMailboxes | ( | const Types::Mailbox::List & | mailboxes | ) |
Sets the mailboxes listed in this header, replacing the current content.
- Since
- 24.12
Definition at line 349 of file headers.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:05:57 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.