libkpimidentities

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
KPIM::Identity Class Reference

#include <identity.h>

Public Types

typedef TQValueList< Identity > List
 

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 &)
 
TDE_DEPRECATED TQCString pgpIdentity () const
 
TDE_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)
 
TDE_DEPRECATED TQString emailAddr () const
 
TDE_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)
 
Signature & signature ()
 
const Signature & signature () 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 Identity & null ()
 

Protected Member Functions

void readConfig (const TDEConfigBase *)
 
void writeConfig (TDEConfigBase *) 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 95 of file identity.h.

Constructor & Destructor Documentation

◆ Identity()

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

◆ ~Identity()

Identity::~Identity ( )

Destructor.

Definition at line 313 of file identity.cpp.

Member Function Documentation

◆ bcc()

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

email addresses for the BCC: field

Definition at line 242 of file identity.h.

◆ dictionary()

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

dictionary which should be used for spell checking

Definition at line 297 of file identity.h.

◆ drafts()

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

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

Definition at line 288 of file identity.h.

◆ emailAddr()

TDE_DEPRECATED TQString KPIM::Identity::emailAddr ( ) const
inline

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

Definition at line 215 of file identity.h.

◆ emailAliases()

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

email address aliases

Definition at line 224 of file identity.h.

◆ fcc()

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

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

Definition at line 283 of file identity.h.

◆ fullEmailAddr()

TQString Identity::fullEmailAddr ( void  ) const

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

Definition at line 522 of file identity.cpp.

◆ fullName()

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

Full name of the user.

Definition at line 182 of file identity.h.

◆ identityName()

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

Identity/nickname for this collection.

Definition at line 157 of file identity.h.

◆ isDefault()

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

Definition at line 161 of file identity.h.

◆ mailingAllowed()

bool Identity::mailingAllowed ( ) const

Tests if there are enough values set to allow mailing.

Definition at line 438 of file identity.cpp.

◆ operator<()

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

used for sorting

Definition at line 116 of file identity.h.

◆ operator==()

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

used for comparison

Definition at line 250 of file identity.cpp.

◆ organization()

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

The user's organization (optional)

Definition at line 186 of file identity.h.

◆ pgpEncryptionKey()

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

The user's OpenPGP encryption key.

Definition at line 196 of file identity.h.

◆ pgpSigningKey()

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

The user's OpenPGP signing key.

Definition at line 200 of file identity.h.

◆ primaryEmailAddress()

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 220 of file identity.h.

◆ readConfig()

void Identity::readConfig ( const TDEConfigBase *  config)
protected

Read configuration from config.

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

Definition at line 318 of file identity.cpp.

◆ replyToAddr()

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

email address for the ReplyTo: field

Definition at line 238 of file identity.h.

◆ setIsDefault()

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

◆ signatureFile()

TQString KPIM::Identity::signatureFile ( ) const
inlineprotected

name of the signature file (with path)

Definition at line 258 of file identity.h.

◆ signatureInlineText()

TQString KPIM::Identity::signatureInlineText ( ) const
inlineprotected

inline signature

Definition at line 262 of file identity.h.

◆ signatureIsCommand()

bool KPIM::Identity::signatureIsCommand ( ) const
inlineprotected
Returns
true if the signature is read from the output of a command

Definition at line 251 of file identity.h.

◆ signatureIsInline()

bool KPIM::Identity::signatureIsInline ( ) const
inlineprotected
Returns
true if the signature was specified directly

Definition at line 255 of file identity.h.

◆ signatureIsPlainFile()

bool KPIM::Identity::signatureIsPlainFile ( ) const
inlineprotected
Returns
true if the signature is read from a text file

Definition at line 253 of file identity.h.

◆ signatureText()

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

◆ smimeEncryptionKey()

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

The user's S/MIME encryption key.

Definition at line 204 of file identity.h.

◆ smimeSigningKey()

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

The user's S/MIME signing key.

Definition at line 208 of file identity.h.

◆ templates()

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

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

Definition at line 293 of file identity.h.

◆ transport()

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 278 of file identity.h.

◆ uoid()

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

Unique Object Identifier for this identity.

Definition at line 164 of file identity.h.

◆ useSignatureFile()

bool KPIM::Identity::useSignatureFile ( ) const
inlineprotected

Inline or signature from a file.

Definition at line 266 of file identity.h.

◆ vCardFile()

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

vCard to attach to outgoing emails

Definition at line 230 of file identity.h.

◆ writeConfig()

void Identity::writeConfig ( TDEConfigBase *  config) const
protected

Write configuration to config.

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

Definition at line 355 of file identity.cpp.

◆ xface()

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

a X-Face header for this identity

Definition at line 301 of file identity.h.

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