• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

kpimidentities

  • KPIMIdentities
  • Identity
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
KPIMIdentities::Identity Class Reference

#include <identity.h>

List of all members.

Public Types

typedef QList< Identity > List

Public Member Functions

 Identity (const QString &id=QString(), const QString &realName=QString(), const QString &emailAddr=QString(), const QString &organization=QString(), const QString &replyToAddress=QString())
 ~Identity ()
QString bcc () const
QString dictionary () const
QString drafts () const
QString emailAddr () const
const QStringList emailAliases () const
QString fcc () const
QString fullEmailAddr () const
QString fullName () const
QString identityName () const
bool isDefault () const
bool isNull () const
bool isXFaceEnabled () const
bool mailingAllowed () const
bool matchesEmailAddress (const QString &addr) const
bool operator!= (const Identity &other) const
bool operator< (const Identity &other) const
bool operator<= (const Identity &other) const
bool operator== (const Identity &other) const
bool operator> (const Identity &other) const
bool operator>= (const Identity &other) const
QString organization () const
QByteArray pgpEncryptionKey () const
QByteArray pgpSigningKey () const
void populateMimeData (QMimeData *)
QString preferredCryptoMessageFormat () const
QString primaryEmailAddress () const
QVariant property (const QString &key) const
void readConfig (const KConfigGroup &)
QString replyToAddr () const
void setBcc (const QString &)
void setDictionary (const QString &)
void setDrafts (const QString &)
void setEmailAddr (const QString &)
void setEmailAliases (const QStringList &aliases)
void setFcc (const QString &)
void setFullName (const QString &)
void setIdentityName (const QString &name)
void setIsDefault (bool flag)
void setOrganization (const QString &)
void setPGPEncryptionKey (const QByteArray &key)
void setPGPSigningKey (const QByteArray &key)
void setPreferredCryptoMessageFormat (const QString &)
void setPrimaryEmailAddress (const QString &email)
void setProperty (const QString &key, const QVariant &value)
void setReplyToAddr (const QString &)
void setSignature (const Signature &sig)
void setSMIMEEncryptionKey (const QByteArray &key)
void setSMIMESigningKey (const QByteArray &key)
void setTemplates (const QString &)
void setTransport (const QString &)
void setUoid (uint aUoid)
void setVCardFile (const QString &)
void setXFace (const QString &)
void setXFaceEnabled (const bool)
Signature & signature ()
bool signatureIsInlinedHtml () const
QString signatureText (bool *ok=0) const
QByteArray smimeEncryptionKey () const
QByteArray smimeSigningKey () const
QString templates () const
QString transport () const
uint uoid () const
QString vCardFile () const
void writeConfig (KConfigGroup &) const
QString xface () const

Static Public Member Functions

static bool canDecode (const QMimeData *)
static Identity fromMimeData (const QMimeData *)
static QString mimeDataType ()
static const Identity & null ()

Protected Member Functions

void setSignatureFile (const QString &)
void setSignatureInlineText (const QString &)
QString signatureFile () const
QString signatureInlineText () const
bool signatureIsCommand () const
bool signatureIsInline () const
bool signatureIsPlainFile () const
bool useSignatureFile () const

Protected Attributes

bool mIsDefault
QHash< QString, QVariant > mPropertiesMap
Signature mSignature

Friends

KPIMIDENTITIES_EXPORT QDataStream & operator<< (QDataStream &stream, const KPIMIdentities::Identity &ident)
KPIMIDENTITIES_EXPORT QDataStream & operator>> (QDataStream &stream, KPIMIdentities::Identity &ident)

Detailed Description

User identity information.

Definition at line 77 of file identity.h.


Constructor & Destructor Documentation

Identity::Identity ( const QString &  id = QString(),
const QString &  realName = QString(),
const QString &  emailAddr = QString(),
const QString &  organization = QString(),
const QString &  replyToAddress = QString() 
) [explicit]

Constructor.

Definition at line 50 of file identity.cpp.

Identity::~Identity ( )

Destructor.

Definition at line 64 of file identity.cpp.


Member Function Documentation

QString Identity::bcc ( ) const

email addresses for the BCC: field

Definition at line 395 of file identity.cpp.

QString Identity::dictionary ( ) const

Dictionary which should be used for spell checking.

Note that this is the localized language name (e.g. "British English"), _not_ the language code or dictionary name!

Definition at line 415 of file identity.cpp.

QString Identity::drafts ( ) const

The folder where draft messages from this identity will be stored by default.

TODO: KDE5 Change QString to int as the folder is an akonadi collection id.

Definition at line 425 of file identity.cpp.

QString Identity::emailAddr ( ) const

email address (without the user name - only name@host)

Deprecated:
Use the primary email address or aliases, depending on your usecase
See also:
primaryEmailAddress(), setPrimaryEmailAddress(), emailAliases(), setEmailAliases(), matchesEmailAddress()

Definition at line 370 of file identity.cpp.

const QStringList Identity::emailAliases ( ) const

email address aliases

Since:
4.6

Definition at line 380 of file identity.cpp.

QString Identity::fcc ( ) const

The folder where sent messages from this identity will be stored by default.

Definition at line 430 of file identity.cpp.

QString Identity::fullEmailAddr ( void  ) const

email address in the format "username <name@host>" suitable for the "From:" field of email messages.

Definition at line 274 of file identity.cpp.

QString Identity::fullName ( ) const

Full name of the user.

Definition at line 335 of file identity.cpp.

QString Identity::identityName ( ) const

Identity/nickname for this collection.

Definition at line 310 of file identity.cpp.

bool Identity::isDefault ( ) const
Returns:
whether this identity is the default identity

Definition at line 325 of file identity.cpp.

bool Identity::isNull ( ) const

Returns true when the identity contains no values, all null values or only empty values.

Definition at line 75 of file identity.cpp.

bool Identity::mailingAllowed ( ) const

Tests if there are enough values set to allow mailing.

Definition at line 129 of file identity.cpp.

bool Identity::matchesEmailAddress ( const QString &  addr) const
Returns:
true if this identity contains the email address addr, either as primary address or as alias
Since:
4.6

Definition at line 616 of file identity.cpp.

bool Identity::operator!= ( const Identity &  other) const

used for comparison

Definition at line 262 of file identity.cpp.

bool Identity::operator< ( const Identity &  other) const

used for sorting

Definition at line 224 of file identity.cpp.

bool Identity::operator<= ( const Identity &  other) const

used for sorting

Definition at line 246 of file identity.cpp.

bool Identity::operator== ( const Identity &  other) const

used for comparison

Definition at line 256 of file identity.cpp.

bool Identity::operator> ( const Identity &  other) const

used for sorting

Definition at line 235 of file identity.cpp.

bool Identity::operator>= ( const Identity &  other) const

used for sorting

Definition at line 251 of file identity.cpp.

QString Identity::organization ( ) const

The user's organization (optional)

Definition at line 340 of file identity.cpp.

QByteArray Identity::pgpEncryptionKey ( ) const

The user's OpenPGP encryption key.

Definition at line 345 of file identity.cpp.

QByteArray Identity::pgpSigningKey ( ) const

The user's OpenPGP signing key.

Definition at line 350 of file identity.cpp.

QString Identity::primaryEmailAddress ( ) const

primary email address (without the user name - only name@host).

The primary email address is used for all outgoing mail.

Since:
4.6

Definition at line 375 of file identity.cpp.

QVariant Identity::property ( const QString &  key) const

Get random properties.

Definition at line 269 of file identity.cpp.

void Identity::readConfig ( const KConfigGroup &  config)

Read configuration from config.

Group must be preset (or use KConfigGroup). Called from IdentityManager.

Definition at line 99 of file identity.cpp.

QString Identity::replyToAddr ( ) const

email address for the ReplyTo: field

Definition at line 390 of file identity.cpp.

void Identity::setIdentityName ( const QString &  name)

Identity/nickname for this collection.

Definition at line 487 of file identity.cpp.

void Identity::setIsDefault ( bool  flag)

Set whether this identity is the default identity.

Since this affects all other identites, too (most notably, the old default identity), only the IdentityManager can change this. You should use

          kmkernel->identityManager()->setAsDefault( name_of_default )
          

instead.

Definition at line 587 of file identity.cpp.

void Identity::setProperty ( const QString &  key,
const QVariant &  value 
)

Set random properties, when value is empty (for QStrings) or null, the property is deleted.

Definition at line 472 of file identity.cpp.

void Identity::setUoid ( uint  aUoid)

set the uiod

Definition at line 482 of file identity.cpp.

QString Identity::signatureFile ( ) const [protected]

name of the signature file (with path)

Definition at line 465 of file identity.cpp.

QString Identity::signatureInlineText ( ) const [protected]

inline signature

Definition at line 460 of file identity.cpp.

bool Identity::signatureIsCommand ( ) const [protected]
Returns:
true if the signature is read from the output of a command

Definition at line 440 of file identity.cpp.

bool Identity::signatureIsInline ( ) const [protected]
Returns:
true if the signature was specified directly

Definition at line 450 of file identity.cpp.

bool Identity::signatureIsInlinedHtml ( ) const
Since:
4.1
Returns:
true if the inlined signature is html formatted

Definition at line 320 of file identity.cpp.

bool Identity::signatureIsPlainFile ( ) const [protected]
Returns:
true if the signature is read from a text file

Definition at line 445 of file identity.cpp.

QString Identity::signatureText ( bool *  ok = 0) const
Returns:
the signature with '--
' prepended to it if it is not present already. No newline in front of or after the signature is added. If ok is a valid bool pointer, ok is set to true or false depending on whether the signature could successfully be obtained.

Definition at line 315 of file identity.cpp.

QByteArray Identity::smimeEncryptionKey ( ) const

The user's S/MIME encryption key.

Definition at line 355 of file identity.cpp.

QByteArray Identity::smimeSigningKey ( ) const

The user's S/MIME signing key.

Definition at line 360 of file identity.cpp.

QString Identity::templates ( ) const

The folder where template messages from this identity will be stored by default.

TODO: KDE5 Change QString to int as the folder is an akonadi collection id.

Definition at line 420 of file identity.cpp.

QString Identity::transport ( ) const

The transport that is set for this identity.

Used to link a transport with an identity.

Definition at line 435 of file identity.cpp.

uint Identity::uoid ( ) const

Unique Object Identifier for this identity.

Definition at line 330 of file identity.cpp.

bool Identity::useSignatureFile ( ) const [protected]

Inline or signature from a file.

Definition at line 455 of file identity.cpp.

QString Identity::vCardFile ( ) const

vCard to attach to outgoing emails

Definition at line 385 of file identity.cpp.

void Identity::writeConfig ( KConfigGroup &  config) const

Write configuration to config.

Group must be preset (or use KConfigGroup). Called from IdentityManager.

Definition at line 117 of file identity.cpp.

QString Identity::xface ( ) const

a X-Face header for this identity

Definition at line 410 of file identity.cpp.


The documentation for this class was generated from the following files:
  • identity.h
  • identity.cpp

kpimidentities

Skip menu "kpimidentities"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal