libkpimidentities

KPIM::Identity Class Reference

#include <identity.h>

List of all members.


Detailed Description

User identity information.

Definition at line 88 of file identity.h.


Public Types

typedef QValueList< IdentityList

Public Member Functions

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
 Identity (const QString &id=QString::null, const QString &realName=QString::null, const QString &emailAddr=QString::null, const QString &organization=QString::null, const QString &replyToAddress=QString::null)
 ~Identity ()
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 &)
KDE_DEPRECATED QCString pgpIdentity () const
KDE_DEPRECATED void setPgpIdentity (const QCString &key)
QCString pgpEncryptionKey () const
void setPGPEncryptionKey (const QCString &key)
QCString pgpSigningKey () const
void setPGPSigningKey (const QCString &key)
QCString smimeEncryptionKey () const
void setSMIMEEncryptionKey (const QCString &key)
QCString smimeSigningKey () const
void setSMIMESigningKey (const QCString &key)
Kleo::CryptoMessageFormat preferredCryptoMessageFormat () const
void setPreferredCryptoMessageFormat (Kleo::CryptoMessageFormat format)
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 &aBcc)
void setSignature (const Signature &sig)
Signaturesignature ()
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)
bool isNull () const

Static Public Member Functions

static const Identitynull ()

Protected Member Functions

void readConfig (const KConfigBase *)
void writeConfig (KConfigBase *) 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

uint mUoid
QString mIdentity
QString mFullName
QString mEmailAddr
QString mOrganization
QString mReplyToAddr
QString mBcc
QString mVCardFile
QCString mPGPEncryptionKey
QCString mPGPSigningKey
QCString mSMIMEEncryptionKey
QCString mSMIMESigningKey
QString mFcc
QString mDrafts
QString mTemplates
QString mTransport
QString mDictionary
QString mXFace
bool mXFaceEnabled
Signature mSignature
bool mIsDefault
Kleo::CryptoMessageFormat mPreferredCryptoMessageFormat

Friends

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 293 of file identity.cpp.

Identity::~Identity (  ) 

Destructor.

Definition at line 311 of file identity.cpp.


Member Function Documentation

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

used for comparison

Definition at line 250 of file identity.cpp.

bool KPIM::Identity::operator< ( const Identity other  )  const [inline]

used for sorting

Definition at line 109 of file identity.h.

void Identity::readConfig ( const KConfigBase *   )  [protected]

Read configuration from config.

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

Definition at line 316 of file identity.cpp.

void Identity::writeConfig ( KConfigBase *   )  const [protected]

Write configuration to config.

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

Definition at line 352 of file identity.cpp.

bool Identity::mailingAllowed (  )  const

Tests if there are enough values set to allow mailing.

Definition at line 432 of file identity.cpp.

QString KPIM::Identity::identityName (  )  const [inline]

Identity/nickname for this collection.

Definition at line 150 of file identity.h.

bool KPIM::Identity::isDefault (  )  const [inline]

Returns:
whether this identity is the default identity

Definition at line 154 of file identity.h.

uint KPIM::Identity::uoid (  )  const [inline]

Unique Object Identifier for this identity.

Definition at line 157 of file identity.h.

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

QString KPIM::Identity::fullName (  )  const [inline]

Full name of the user.

Definition at line 175 of file identity.h.

QString KPIM::Identity::organization (  )  const [inline]

The user's organization (optional).

Definition at line 179 of file identity.h.

QCString KPIM::Identity::pgpEncryptionKey (  )  const [inline]

The user's OpenPGP encryption key.

Definition at line 189 of file identity.h.

QCString KPIM::Identity::pgpSigningKey (  )  const [inline]

The user's OpenPGP signing key.

Definition at line 193 of file identity.h.

QCString KPIM::Identity::smimeEncryptionKey (  )  const [inline]

The user's S/MIME encryption key.

Definition at line 197 of file identity.h.

QCString KPIM::Identity::smimeSigningKey (  )  const [inline]

The user's S/MIME signing key.

Definition at line 201 of file identity.h.

QString KPIM::Identity::emailAddr (  )  const [inline]

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

Definition at line 208 of file identity.h.

QString KPIM::Identity::vCardFile (  )  const [inline]

vCard to attach to outgoing emails

Definition at line 212 of file identity.h.

QString Identity::fullEmailAddr (  )  const

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

Definition at line 501 of file identity.cpp.

QString KPIM::Identity::replyToAddr (  )  const [inline]

email address for the ReplyTo: field

Definition at line 220 of file identity.h.

QString KPIM::Identity::bcc (  )  const [inline]

email addresses for the BCC: field

Definition at line 224 of file identity.h.

bool KPIM::Identity::signatureIsCommand (  )  const [inline, protected]

Returns:
true if the signature is read from the output of a command

Definition at line 232 of file identity.h.

bool KPIM::Identity::signatureIsPlainFile (  )  const [inline, protected]

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

Definition at line 234 of file identity.h.

bool KPIM::Identity::signatureIsInline (  )  const [inline, protected]

Returns:
true if the signature was specified directly

Definition at line 236 of file identity.h.

QString KPIM::Identity::signatureFile (  )  const [inline, protected]

name of the signature file (with path)

Definition at line 239 of file identity.h.

QString KPIM::Identity::signatureInlineText (  )  const [inline, protected]

inline signature

Definition at line 243 of file identity.h.

bool KPIM::Identity::useSignatureFile (  )  const [inline, protected]

Inline or signature from a file.

Definition at line 247 of file identity.h.

QString Identity::signatureText ( bool *  ok = 0  )  const

Returns the signature.

This method also takes care of special signature files that are shell scripts and handles them correct. So use this method to rectreive the contents of the signature file. If prompt is false, no errors will be displayed (useful for retries).

Definition at line 611 of file identity.cpp.

QString KPIM::Identity::transport (  )  const [inline]

The transport that is set for this identity.

Used to link a transport with an identity.

Definition at line 259 of file identity.h.

QString KPIM::Identity::fcc (  )  const [inline]

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

Definition at line 264 of file identity.h.

QString KPIM::Identity::drafts (  )  const [inline]

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

Definition at line 269 of file identity.h.

QString KPIM::Identity::templates (  )  const [inline]

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

Definition at line 274 of file identity.h.

QString KPIM::Identity::dictionary (  )  const [inline]

dictionary which should be used for spell checking

Definition at line 278 of file identity.h.

QString KPIM::Identity::xface (  )  const [inline]

a X-Face header for this identity

Definition at line 282 of file identity.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys