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

KMIME Library

  • KMime
  • Types
  • Mailbox
Public Types | Public Member Functions | List of all members
KMime::Types::Mailbox Class Reference

#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 68 of file kmime_header_parsing.h.

Member Enumeration Documentation

enum KMime::Types::Mailbox::Quoting

Describes how display names should be quoted.

Since
4.5
Enumerator
QuoteNever 

Don't quote display names at all.

Such an unquoted display name can not be machine-processed anymore in some cases, for example when it contains commas, like in "Lastname, Firstname".

QuoteWhenNecessary 

Only quote display names when they contain characters that need to be quoted, like commas or quote signs.

QuoteAlways 

Always quote the display name.

Definition at line 129 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
encCharsetThe 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 &lt;address&gt;".

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
quotingdescribes 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:
  • kmime_header_parsing.h
  • kmime_header_parsing.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:25:49 by doxygen 1.8.3.1 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.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • 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