• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

kpimidentities

KPIMIdentities::Identity

KPIMIdentities::Identity Class Reference

#include <identity.h>

List of all members.


Detailed Description

User identity information.

Definition at line 76 of file identity.h.


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 ()
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
bool mailingAllowed () const
QString identityName () const
void setIdentityName (const QString &name)
bool isDefault () const
uint uoid () const
QString fullName () const
void setFullName (const QString &)
QString organization () const
void setOrganization (const QString &)
QByteArray pgpEncryptionKey () const
void setPGPEncryptionKey (const QByteArray &key)
QByteArray pgpSigningKey () const
void setPGPSigningKey (const QByteArray &key)
QByteArray smimeEncryptionKey () const
void setSMIMEEncryptionKey (const QByteArray &key)
QByteArray smimeSigningKey () const
void setSMIMESigningKey (const QByteArray &key)
QString preferredCryptoMessageFormat () const
void setPreferredCryptoMessageFormat (const QString &)
QString emailAddr () const
void setEmailAddr (const QString &)
QString vCardFile () const
void setVCardFile (const QString &)
QString fullEmailAddr () const
QString replyToAddr () const
void setReplyToAddr (const QString &)
QString bcc () const
void setBcc (const QString &)
void setSignature (const Signature &sig)
Signature & signature ()
QString signatureText (bool *ok=0) const
QString transport () const
void setTransport (const QString &)
QString fcc () const
void setFcc (const QString &)
QString drafts () const
void setDrafts (const QString &)
QString templates () const
void setTemplates (const QString &)
QString dictionary () const
void setDictionary (const QString &)
QString xface () const
void setXFace (const QString &)
bool isXFaceEnabled () const
void setXFaceEnabled (const bool)
QVariant property (const QString &key) const
void setProperty (const QString &key, const QVariant &value)
bool isNull () const
void populateMimeData (QMimeData *)

Static Public Member Functions

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

Protected Member Functions

void readConfig (const KConfigGroup &)
void writeConfig (KConfigGroup &) const
void setIsDefault (bool flag)
void setUoid (uint aUoid)
bool signatureIsCommand () const
bool signatureIsPlainFile () const
bool signatureIsInline () const
QString signatureFile () const
void setSignatureFile (const QString &)
QString signatureInlineText () const
void setSignatureInlineText (const QString &)
bool useSignatureFile () const

Protected Attributes

Signature mSignature
bool mIsDefault
QHash< QString, QVariant > mPropertiesMap

Friends

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

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 47 of file identity.cpp.

Identity::~Identity (  ) 

Destructor.

Definition at line 60 of file identity.cpp.


Member Function Documentation

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

used for comparison

Definition at line 237 of file identity.cpp.

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

used for comparison

Definition at line 243 of file identity.cpp.

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

used for sorting

Definition at line 205 of file identity.cpp.

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

used for sorting

Definition at line 216 of file identity.cpp.

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

used for sorting

Definition at line 227 of file identity.cpp.

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

used for sorting

Definition at line 232 of file identity.cpp.

bool Identity::mailingAllowed (  )  const

Tests if there are enough values set to allow mailing.

Definition at line 112 of file identity.cpp.

QString Identity::identityName (  )  const

Identity/nickname for this collection.

Definition at line 290 of file identity.cpp.

void Identity::setIdentityName ( const QString &  name  ) 

Identity/nickname for this collection.

Definition at line 452 of file identity.cpp.

bool Identity::isDefault (  )  const

Returns:
whether this identity is the default identity

Definition at line 300 of file identity.cpp.

uint Identity::uoid (  )  const

Unique Object Identifier for this identity.

Definition at line 305 of file identity.cpp.

QString Identity::fullName (  )  const

Full name of the user.

Definition at line 310 of file identity.cpp.

QString Identity::organization (  )  const

The user's organization (optional).

Definition at line 315 of file identity.cpp.

QByteArray Identity::pgpEncryptionKey (  )  const

The user's OpenPGP encryption key.

Definition at line 320 of file identity.cpp.

QByteArray Identity::pgpSigningKey (  )  const

The user's OpenPGP signing key.

Definition at line 325 of file identity.cpp.

QByteArray Identity::smimeEncryptionKey (  )  const

The user's S/MIME encryption key.

Definition at line 330 of file identity.cpp.

QByteArray Identity::smimeSigningKey (  )  const

The user's S/MIME signing key.

Definition at line 335 of file identity.cpp.

QString Identity::emailAddr (  )  const

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

Definition at line 345 of file identity.cpp.

QString Identity::vCardFile (  )  const

vCard to attach to outgoing emails

Definition at line 350 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 255 of file identity.cpp.

QString Identity::replyToAddr (  )  const

email address for the ReplyTo: field

Definition at line 355 of file identity.cpp.

QString Identity::bcc (  )  const

email addresses for the BCC: field

Definition at line 360 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 wether the signature could successfully be obtained.

Definition at line 295 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 400 of file identity.cpp.

QString Identity::fcc (  )  const

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

Definition at line 395 of file identity.cpp.

QString Identity::drafts (  )  const

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

Definition at line 390 of file identity.cpp.

QString Identity::templates (  )  const

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

Definition at line 385 of file identity.cpp.

QString Identity::dictionary (  )  const

dictionary which should be used for spell checking

Definition at line 380 of file identity.cpp.

QString Identity::xface (  )  const

a X-Face header for this identity

Definition at line 375 of file identity.cpp.

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

Get random properties.

Definition at line 250 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 437 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 71 of file identity.cpp.

void Identity::readConfig ( const KConfigGroup &  config  )  [protected]

Read configuration from config.

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

Definition at line 89 of file identity.cpp.

void Identity::writeConfig ( KConfigGroup &  config  )  const [protected]

Write configuration to config.

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

Definition at line 101 of file identity.cpp.

void Identity::setIsDefault ( bool  flag  )  [protected]

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 542 of file identity.cpp.

void Identity::setUoid ( uint  aUoid  )  [protected]

set the uiod

Definition at line 447 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 405 of file identity.cpp.

bool Identity::signatureIsPlainFile (  )  const [protected]

Returns:
true if the signature is read from a text file

Definition at line 410 of file identity.cpp.

bool Identity::signatureIsInline (  )  const [protected]

Returns:
true if the signature was specified directly

Definition at line 415 of file identity.cpp.

QString Identity::signatureFile (  )  const [protected]

name of the signature file (with path)

Definition at line 430 of file identity.cpp.

QString Identity::signatureInlineText (  )  const [protected]

inline signature

Definition at line 425 of file identity.cpp.

bool Identity::useSignatureFile (  )  const [protected]

Inline or signature from a file.

Definition at line 420 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
  • File List
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
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