libkpimidentities

KPIM::Identity Class Reference

User identity information. More...

#include <identity.h>

List of all members.

Public Types

typedef TQValueList< 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 TQString &id=TQString(), const TQString &realName=TQString(), const TQString &emailAddr=TQString(), const TQString &organization=TQString(), const TQString &replyToAddress=TQString())
 ~Identity ()
bool mailingAllowed () const
TQString identityName () const
void setIdentityName (const TQString &name)
bool isDefault () const
uint uoid () const
TQString fullName () const
void setFullName (const TQString &)
TQString organization () const
void setOrganization (const TQString &)
KDE_DEPRECATED TQCString pgpIdentity () const
KDE_DEPRECATED void setPgpIdentity (const TQCString &key)
TQCString pgpEncryptionKey () const
void setPGPEncryptionKey (const TQCString &key)
TQCString pgpSigningKey () const
void setPGPSigningKey (const TQCString &key)
TQCString smimeEncryptionKey () const
void setSMIMEEncryptionKey (const TQCString &key)
TQCString smimeSigningKey () const
void setSMIMESigningKey (const TQCString &key)
Kleo::CryptoMessageFormat preferredCryptoMessageFormat () const
void setPreferredCryptoMessageFormat (Kleo::CryptoMessageFormat format)
KDE_DEPRECATED TQString emailAddr () const
KDE_DEPRECATED void setEmailAddr (const TQString &email)
TQString primaryEmailAddress () const
void setPrimaryEmailAddress (const TQString &email)
const TQStringList & emailAliases () const
void setEmailAliases (const TQStringList &)
bool matchesEmailAddress (const TQString &addr) const
TQString vCardFile () const
void setVCardFile (const TQString &)
TQString fullEmailAddr () const
TQString replyToAddr () const
void setReplyToAddr (const TQString &)
TQString bcc () const
void setBcc (const TQString &aBcc)
void setSignature (const Signature &sig)
Signaturesignature ()
const Signaturesignature () const
TQString signatureText (bool *ok=0) const
TQString transport () const
void setTransport (const TQString &)
TQString fcc () const
void setFcc (const TQString &)
TQString drafts () const
void setDrafts (const TQString &)
TQString templates () const
void setTemplates (const TQString &)
TQString dictionary () const
void setDictionary (const TQString &)
TQString xface () const
void setXFace (const TQString &)
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
TQString signatureFile () const
void setSignatureFile (const TQString &)
TQString signatureInlineText () const
void setSignatureInlineText (const TQString &)
bool useSignatureFile () const

Protected Attributes

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

Friends

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

Detailed Description

User identity information.

Definition at line 89 of file identity.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 296 of file identity.cpp.

Identity::~Identity (  ) 

Destructor.

Definition at line 314 of file identity.cpp.


Member Function Documentation

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

email addresses for the BCC: field

Definition at line 236 of file identity.h.

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

dictionary which should be used for spell checking

Definition at line 291 of file identity.h.

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

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

Definition at line 282 of file identity.h.

KDE_DEPRECATED TQString KPIM::Identity::emailAddr (  )  const [inline]

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

Definition at line 209 of file identity.h.

const TQStringList& KPIM::Identity::emailAliases (  )  const [inline]

email address aliases

Definition at line 218 of file identity.h.

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

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

Definition at line 277 of file identity.h.

TQString Identity::fullEmailAddr ( void   )  const

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

Definition at line 523 of file identity.cpp.

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

Full name of the user.

Definition at line 176 of file identity.h.

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

Identity/nickname for this collection.

Definition at line 151 of file identity.h.

bool KPIM::Identity::isDefault (  )  const [inline]
Returns:
whether this identity is the default identity

Definition at line 155 of file identity.h.

bool Identity::mailingAllowed (  )  const

Tests if there are enough values set to allow mailing.

Definition at line 439 of file identity.cpp.

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

used for sorting

Definition at line 110 of file identity.h.

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

used for comparison

Definition at line 251 of file identity.cpp.

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

The user's organization (optional).

Definition at line 180 of file identity.h.

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

The user's OpenPGP encryption key.

Definition at line 190 of file identity.h.

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

The user's OpenPGP signing key.

Definition at line 194 of file identity.h.

TQString KPIM::Identity::primaryEmailAddress (  )  const [inline]

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

The primary email address is used for all outgoing mail.

Definition at line 214 of file identity.h.

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

Read configuration from config.

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

Definition at line 319 of file identity.cpp.

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

email address for the ReplyTo: field

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

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

name of the signature file (with path)

Definition at line 252 of file identity.h.

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

inline signature

Definition at line 256 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 245 of file identity.h.

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

Definition at line 249 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 247 of file identity.h.

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

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

The user's S/MIME encryption key.

Definition at line 198 of file identity.h.

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

The user's S/MIME signing key.

Definition at line 202 of file identity.h.

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

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

Definition at line 287 of file identity.h.

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

The transport that is set for this identity.

Used to link a transport with an identity.

Definition at line 272 of file identity.h.

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

Unique Object Identifier for this identity.

Definition at line 158 of file identity.h.

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

Inline or signature from a file.

Definition at line 260 of file identity.h.

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

vCard to attach to outgoing emails

Definition at line 224 of file identity.h.

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

Write configuration to config.

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

Definition at line 356 of file identity.cpp.

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

a X-Face header for this identity

Definition at line 295 of file identity.h.


The documentation for this class was generated from the following files: