KDE PIM / Developers / API Docs / libkpimidentities

KPIM::Identity Class Reference

User identity information. More...

#include <identity.h>

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends


Detailed Description

User identity information.


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.

Identity::~Identity  ) 
 

Destructor.


Member Function Documentation

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

used for comparison

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

used for sorting

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

Read configuration from config.

Group must be preset (or use

See also:
KConfigGroup). Called from

IdentityManager.

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

Write configuration to config.

Group must be preset (or use

See also:
KConfigGroup). Called from

IdentityManager.

bool Identity::mailingAllowed  )  const
 

Tests if there are enough values set to allow mailing.

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

Identity/nickname for this collection.

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

Returns:
whether this identity is the default identity

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

Unique Object Identifier for this identity.

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

See also:
IdentityManager can change this. You should use
      kmkernel->identityManager()->setAsDefault( name_of_default )
      
instead.

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

Full name of the user.

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

The user's organization (optional).

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

The user's OpenPGP encryption key.

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

The user's OpenPGP signing key.

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

The user's S/MIME encryption key.

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

The user's S/MIME signing key.

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

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

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

vCard to attach to outgoing emails

QString Identity::fullEmailAddr  )  const
 

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

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

email address for the ReplyTo: field

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

email addresses for the BCC: field

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

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

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

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

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

Returns:
true if the signature was specified directly

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

name of the signature file (with path)

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

inline signature

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

Inline or signature from a file.

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).

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

The transport that is set for this identity.

Used to link a transport with an identity.

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

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

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

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

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

dictionary which should be used for spell checking

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

a X-Face header for this identity


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