kmail Library API Documentation

KMIdentity Class Reference

User identity information. More...

#include <kmidentity.h>

List of all members.

Public Types

typedef QValueList< KMIdentity > List

Public Methods

bool operator== (const KMIdentity &other) const
bool operator!= (const KMIdentity &other) const
bool operator< (const KMIdentity &other) const
bool operator> (const KMIdentity &other) const
bool operator<= (const KMIdentity &other) const
bool operator>= (const KMIdentity &other) const
 KMIdentity (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)
 ~KMIdentity ()
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 &)
QCString pgpIdentity () const
void setPgpIdentity (const QCString &)
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 dictionary () const
void setDictionary (const QString &)
bool isNull () const

Static Public Attributes

KMIdentity null

Protected Methods

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 mPgpIdentity
QString mFcc
QString mDrafts
QString mTransport
QString mDictionary
Signature mSignature
bool mIsDefault

Friends

class IdentityManager
QDataStreamoperator<< (QDataStream &stream, const KMIdentity &ident)
QDataStreamoperator>> (QDataStream &stream, KMIdentity &ident)


Detailed Description

User identity information.

Definition at line 81 of file kmidentity.h.


Constructor & Destructor Documentation

KMIdentity::KMIdentity 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 248 of file kmidentity.cpp.

KMIdentity::~KMIdentity  
 

Destructor.

Definition at line 258 of file kmidentity.cpp.


Member Function Documentation

bool KMIdentity::operator== const KMIdentity &    other const
 

used for comparison.

Definition at line 237 of file kmidentity.cpp.

References mBcc, mDictionary, mDrafts, mEmailAddr, mFcc, mFullName, mIdentity, mOrganization, mPgpIdentity, mReplyToAddr, mSignature, mTransport, mUoid, and mVCardFile.

bool KMIdentity::operator< const KMIdentity &    other const [inline]
 

used for sorting.

Definition at line 102 of file kmidentity.h.

References identityName(), and isDefault().

void KMIdentity::readConfig const KConfigBase *    [protected]
 

Read configuration from config.

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

Definition at line 263 of file kmidentity.cpp.

References QString::isEmpty(), and Signature::readConfig().

void KMIdentity::writeConfig KConfigBase *    const [protected]
 

Write configuration to config.

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

Definition at line 290 of file kmidentity.cpp.

References Signature::writeConfig().

bool KMIdentity::mailingAllowed   const
 

Tests if there are enough values set to allow mailing.

Definition at line 352 of file kmidentity.cpp.

References QString::isEmpty().

QString KMIdentity::identityName   const [inline]
 

Identity/nickname for this collection.

Definition at line 143 of file kmidentity.h.

Referenced by operator<().

bool KMIdentity::isDefault   const [inline]
 

Returns:
whether this identity is the default identity

Definition at line 147 of file kmidentity.h.

Referenced by operator<().

void KMIdentity::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 358 of file kmidentity.cpp.

QString KMIdentity::fullName   const [inline]
 

Full name of the user.

Definition at line 167 of file kmidentity.h.

QString KMIdentity::organization   const [inline]
 

The user's organization (optional).

Definition at line 171 of file kmidentity.h.

QCString KMIdentity::pgpIdentity   const [inline]
 

The user's PGP identity.

Definition at line 175 of file kmidentity.h.

QString KMIdentity::emailAddr   const [inline]
 

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

Definition at line 179 of file kmidentity.h.

QString KMIdentity::vCardFile   const [inline]
 

vCard to attach to outgoing emails.

Definition at line 183 of file kmidentity.h.

QString KMIdentity::fullEmailAddr   const
 

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

Definition at line 401 of file kmidentity.cpp.

References QString::contains(), QString::insert(), QString::isEmpty(), and QString::length().

QString KMIdentity::replyToAddr   const [inline]
 

email address for the ReplyTo: field.

Definition at line 191 of file kmidentity.h.

QString KMIdentity::bcc   const [inline]
 

email addresses for the BCC: field.

Definition at line 195 of file kmidentity.h.

bool KMIdentity::signatureIsCommand   const [inline, protected]
 

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

Definition at line 203 of file kmidentity.h.

References Signature::type().

Referenced by useSignatureFile().

bool KMIdentity::signatureIsPlainFile   const [inline, protected]
 

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

Definition at line 205 of file kmidentity.h.

References Signature::type().

Referenced by useSignatureFile().

bool KMIdentity::signatureIsInline   const [inline, protected]
 

Returns:
true if the signature was specified directly

Definition at line 207 of file kmidentity.h.

References Signature::type().

QString KMIdentity::signatureFile   const [inline, protected]
 

name of the signature file (with path).

Definition at line 210 of file kmidentity.h.

References Signature::url().

QString KMIdentity::signatureInlineText   const [inline, protected]
 

inline signature.

Definition at line 214 of file kmidentity.h.

References Signature::text().

bool KMIdentity::useSignatureFile   const [inline, protected]
 

Inline or signature from a file.

Definition at line 218 of file kmidentity.h.

References signatureIsCommand(), and signatureIsPlainFile().

QString KMIdentity::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 479 of file kmidentity.cpp.

References signatureText(), and Signature::withSeparator().

Referenced by signatureText().

QString KMIdentity::transport   const [inline]
 

The transport that is set for this identity.

Used to link a transport with an identity.

Definition at line 230 of file kmidentity.h.

QString KMIdentity::fcc   const [inline]
 

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

Definition at line 235 of file kmidentity.h.

QString KMIdentity::drafts   const [inline]
 

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

Definition at line 240 of file kmidentity.h.

QString KMIdentity::dictionary   const [inline]
 

dictionary which should be used for spell checking.

Definition at line 244 of file kmidentity.h.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:37:36 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003