libkpimidentities
KPIM::Identity Class Reference
#include <identity.h>
Detailed Description
User identity information.Definition at line 89 of file identity.h.
Public Types | |
typedef QValueList< 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 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) |
KDE_DEPRECATED QString | emailAddr () const |
KDE_DEPRECATED void | setEmailAddr (const QString &email) |
QString | primaryEmailAddress () const |
void | setPrimaryEmailAddress (const QString &email) |
const QStringList & | emailAliases () const |
void | setEmailAliases (const QStringList &) |
bool | matchesEmailAddress (const QString &addr) const |
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) |
Signature & | signature () |
const Signature & | signature () const |
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 Identity & | null () |
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 |
QStringList | mEmailAliases |
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] |
Identity::~Identity | ( | ) |
Member Function Documentation
bool Identity::operator== | ( | const Identity & | other | ) | const |
bool KPIM::Identity::operator< | ( | const Identity & | other | ) | const [inline] |
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.
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.
bool Identity::mailingAllowed | ( | ) | const |
QString KPIM::Identity::identityName | ( | ) | const [inline] |
bool KPIM::Identity::isDefault | ( | ) | const [inline] |
uint KPIM::Identity::uoid | ( | ) | const [inline] |
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.
QString KPIM::Identity::fullName | ( | ) | const [inline] |
QString KPIM::Identity::organization | ( | ) | const [inline] |
QCString KPIM::Identity::pgpEncryptionKey | ( | ) | const [inline] |
QCString KPIM::Identity::pgpSigningKey | ( | ) | const [inline] |
QCString KPIM::Identity::smimeEncryptionKey | ( | ) | const [inline] |
QCString KPIM::Identity::smimeSigningKey | ( | ) | const [inline] |
KDE_DEPRECATED QString KPIM::Identity::emailAddr | ( | ) | const [inline] |
QString 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.
const QStringList& KPIM::Identity::emailAliases | ( | ) | const [inline] |
QString KPIM::Identity::vCardFile | ( | ) | const [inline] |
QString 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.
QString KPIM::Identity::replyToAddr | ( | ) | const [inline] |
QString KPIM::Identity::bcc | ( | ) | const [inline] |
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::signatureIsPlainFile | ( | ) | const [inline, protected] |
bool KPIM::Identity::signatureIsInline | ( | ) | const [inline, protected] |
QString KPIM::Identity::signatureFile | ( | ) | const [inline, protected] |
QString KPIM::Identity::signatureInlineText | ( | ) | const [inline, protected] |
bool KPIM::Identity::useSignatureFile | ( | ) | const [inline, protected] |
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 633 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 272 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 277 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 282 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 287 of file identity.h.
QString KPIM::Identity::dictionary | ( | ) | const [inline] |
QString KPIM::Identity::xface | ( | ) | const [inline] |
The documentation for this class was generated from the following files: