KMIME Library
#include <kmime_header_parsing.h>
Public Types | |
typedef QList< Mailbox > | List |
enum | Quoting { QuoteNever, QuoteWhenNecessary, QuoteAlways } |
Public Member Functions | |
QByteArray | address () const |
AddrSpec | addrSpec () const |
QByteArray | as7BitString (const QByteArray &encCharset) const |
void | from7BitString (const QByteArray &s) |
void | fromUnicodeString (const QString &s) |
bool | hasAddress () const |
bool | hasName () const |
QString | name () const |
QString | prettyAddress () const |
QString | prettyAddress (Quoting quoting) const |
void | setAddress (const AddrSpec &addr) |
void | setAddress (const QByteArray &addr) |
void | setName (const QString &name) |
void | setNameFrom7Bit (const QByteArray &name, const QByteArray &defaultCharset=QByteArray()) |
Detailed Description
Represents an (email address, display name) pair according RFC 2822, section 3.4.
Definition at line 69 of file kmime_header_parsing.h.
Member Enumeration Documentation
Describes how display names should be quoted.
- Since
- 4.5
Definition at line 130 of file kmime_header_parsing.h.
Member Function Documentation
QByteArray KMime::Types::Mailbox::address | ( | ) | const |
Returns a string representation of the email address, without the angle brackets.
Definition at line 115 of file kmime_header_parsing.cpp.
QByteArray KMime::Types::Mailbox::as7BitString | ( | const QByteArray & | encCharset | ) | const |
Returns a 7bit transport encoded representation of this mailbox.
- Parameters
-
encCharset The charset used for encoding.
Definition at line 208 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::from7BitString | ( | const QByteArray & | s | ) |
Parses the given 7bit encoded string.
Definition at line 202 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::fromUnicodeString | ( | const QString & | s | ) |
Parses the given unicode string.
Definition at line 197 of file kmime_header_parsing.cpp.
bool KMime::Types::Mailbox::hasAddress | ( | ) | const |
Returns true if this mailbox has an address.
Definition at line 166 of file kmime_header_parsing.cpp.
bool KMime::Types::Mailbox::hasName | ( | ) | const |
Returns true if this mailbox has a display name.
Definition at line 171 of file kmime_header_parsing.cpp.
QString KMime::Types::Mailbox::name | ( | ) | const |
Returns the display name.
Definition at line 131 of file kmime_header_parsing.cpp.
QString KMime::Types::Mailbox::prettyAddress | ( | ) | const |
Returns a assembled display name / address string 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 176 of file kmime_header_parsing.cpp.
QString KMime::Types::Mailbox::prettyAddress | ( | Quoting | quoting | ) | const |
Overloaded method that gives more control over the quoting of the display name.
- Parameters
-
quoting describes how the display name should be quoted
- Since
- 4.5
Definition at line 181 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::setAddress | ( | const AddrSpec & | addr | ) |
Sets the email address.
Definition at line 136 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::setAddress | ( | const QByteArray & | addr | ) |
Sets the email address.
Definition at line 141 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::setName | ( | const QString & | name | ) |
Sets the name.
Definition at line 154 of file kmime_header_parsing.cpp.
void KMime::Types::Mailbox::setNameFrom7Bit | ( | const QByteArray & | name, |
const QByteArray & | defaultCharset = QByteArray() |
||
) |
Sets the name based on a 7bit encoded string.
Definition at line 159 of file kmime_header_parsing.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:11 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.