kpimidentities
KPIMIdentities::Identity Class Reference
#include <identity.h>
Detailed Description
User identity information.Definition at line 76 of file identity.h.
Public Types | |
typedef QList< Identity > | List |
Public Member Functions | |
Identity (const QString &id=QString(), const QString &realName=QString(), const QString &emailAddr=QString(), const QString &organization=QString(), const QString &replyToAddress=QString()) | |
~Identity () | |
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 |
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 &) |
QByteArray | pgpEncryptionKey () const |
void | setPGPEncryptionKey (const QByteArray &key) |
QByteArray | pgpSigningKey () const |
void | setPGPSigningKey (const QByteArray &key) |
QByteArray | smimeEncryptionKey () const |
void | setSMIMEEncryptionKey (const QByteArray &key) |
QByteArray | smimeSigningKey () const |
void | setSMIMESigningKey (const QByteArray &key) |
QString | preferredCryptoMessageFormat () const |
void | setPreferredCryptoMessageFormat (const QString &) |
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 &) |
void | setSignature (const Signature &sig) |
Signature & | signature () |
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) |
QVariant | property (const QString &key) const |
void | setProperty (const QString &key, const QVariant &value) |
bool | isNull () const |
void | populateMimeData (QMimeData *) |
Static Public Member Functions | |
static const Identity & | null () |
static QString | mimeDataType () |
static bool | canDecode (const QMimeData *) |
static Identity | fromMimeData (const QMimeData *) |
Protected Member Functions | |
void | readConfig (const KConfigGroup &) |
void | writeConfig (KConfigGroup &) 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 | |
Signature | mSignature |
bool | mIsDefault |
QHash< QString, QVariant > | mPropertiesMap |
Friends | |
class | IdentityManager |
KPIMIDENTITIES_EXPORT QDataStream & | operator<< (QDataStream &stream, const KPIMIdentities::Identity &ident) |
KPIMIDENTITIES_EXPORT QDataStream & | operator>> (QDataStream &stream, KPIMIdentities::Identity &ident) |
Constructor & Destructor Documentation
Identity::Identity | ( | const QString & | id = QString() , |
|
const QString & | realName = QString() , |
|||
const QString & | emailAddr = QString() , |
|||
const QString & | organization = QString() , |
|||
const QString & | replyToAddress = QString() | |||
) | [explicit] |
Identity::~Identity | ( | ) |
Member Function Documentation
bool Identity::operator== | ( | const Identity & | other | ) | const |
bool Identity::operator!= | ( | const Identity & | other | ) | const |
bool Identity::operator< | ( | const Identity & | other | ) | const |
bool Identity::operator> | ( | const Identity & | other | ) | const |
bool Identity::operator<= | ( | const Identity & | other | ) | const |
bool Identity::operator>= | ( | const Identity & | other | ) | const |
bool Identity::mailingAllowed | ( | ) | const |
QString Identity::identityName | ( | ) | const |
void Identity::setIdentityName | ( | const QString & | name | ) |
bool Identity::isDefault | ( | ) | const |
uint Identity::uoid | ( | ) | const |
QString Identity::fullName | ( | ) | const |
QString Identity::organization | ( | ) | const |
QByteArray Identity::pgpEncryptionKey | ( | ) | const |
QByteArray Identity::pgpSigningKey | ( | ) | const |
QByteArray Identity::smimeEncryptionKey | ( | ) | const |
QByteArray Identity::smimeSigningKey | ( | ) | const |
QString Identity::emailAddr | ( | ) | const |
QString Identity::vCardFile | ( | ) | const |
QString Identity::fullEmailAddr | ( | void | ) | const |
email address in the format "username <name@host>" suitable for the "From:" field of email messages.
Definition at line 255 of file identity.cpp.
QString Identity::replyToAddr | ( | ) | const |
QString Identity::bcc | ( | ) | const |
QString Identity::signatureText | ( | bool * | ok = 0 |
) | const |
- Returns:
- the signature with '--
' prepended to it if it is not present already. No newline in front of or after the signature is added. Ifok
is a valid bool pointer,ok
is set to true or false depending on wether the signature could successfully be obtained.
Definition at line 295 of file identity.cpp.
QString Identity::transport | ( | ) | const |
The transport that is set for this identity.
Used to link a transport with an identity.
Definition at line 400 of file identity.cpp.
QString Identity::fcc | ( | ) | const |
The folder where sent messages from this identity will be stored by default.
Definition at line 395 of file identity.cpp.
QString Identity::drafts | ( | ) | const |
The folder where draft messages from this identity will be stored by default.
Definition at line 390 of file identity.cpp.
QString Identity::templates | ( | ) | const |
The folder where template messages from this identity will be stored by default.
Definition at line 385 of file identity.cpp.
QString Identity::dictionary | ( | ) | const |
QString Identity::xface | ( | ) | const |
QVariant Identity::property | ( | const QString & | key | ) | const |
void Identity::setProperty | ( | const QString & | key, | |
const QVariant & | value | |||
) |
Set random properties, when value
is empty (for QStrings) or null, the property is deleted.
Definition at line 437 of file identity.cpp.
bool Identity::isNull | ( | ) | const |
Returns true when the identity contains no values, all null values or only empty values.
Definition at line 71 of file identity.cpp.
void Identity::readConfig | ( | const KConfigGroup & | config | ) | [protected] |
Read configuration from config.
Group must be preset (or use KConfigGroup). Called from IdentityManager.
Definition at line 89 of file identity.cpp.
void Identity::writeConfig | ( | KConfigGroup & | config | ) | const [protected] |
Write configuration to config.
Group must be preset (or use KConfigGroup). Called from IdentityManager.
Definition at line 101 of file identity.cpp.
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 542 of file identity.cpp.
void Identity::setUoid | ( | uint | aUoid | ) | [protected] |
bool Identity::signatureIsCommand | ( | ) | const [protected] |
- Returns:
- true if the signature is read from the output of a command
Definition at line 405 of file identity.cpp.
bool Identity::signatureIsPlainFile | ( | ) | const [protected] |
bool Identity::signatureIsInline | ( | ) | const [protected] |
QString Identity::signatureFile | ( | ) | const [protected] |
QString Identity::signatureInlineText | ( | ) | const [protected] |
bool Identity::useSignatureFile | ( | ) | const [protected] |
The documentation for this class was generated from the following files: