KIdentityManagement::Identity

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

#include <identity.h>

Public Types

typedef QVector< 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())
 
bool attachVcard () const
 
QString autocorrectionLanguage () const
 
QString bcc () const
 
QString cc () const
 
QString defaultDomainName () const
 
QString dictionary () const
 
bool disabledFcc () const
 
QString drafts () const
 
const QStringList emailAliases () const
 
QString fcc () const
 
QString fullEmailAddr () const
 
QString fullName () const
 
QString identityName () const
 
bool isDefault () const
 
bool isNull () const
 
bool isXFaceEnabled () const
 
bool mailingAllowed () const
 
bool matchesEmailAddress (const QString &addr) 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 operator>= (const Identity &other) const
 
QString organization () const
 
bool pgpAutoEncrypt () const
 
bool pgpAutoSign () const
 
QByteArray pgpEncryptionKey () const
 
QByteArray pgpSigningKey () const
 
void populateMimeData (QMimeData *) const
 
QString preferredCryptoMessageFormat () const
 
QString primaryEmailAddress () const
 
QVariant property (const QString &key) const
 
void readConfig (const KConfigGroup &)
 
QString replyToAddr () const
 
void setAttachVcard (bool attach)
 
void setAutocorrectionLanguage (const QString &language)
 
void setBcc (const QString &)
 
void setCc (const QString &)
 
void setDefaultDomainName (const QString &domainName)
 
void setDictionary (const QString &)
 
void setDisabledFcc (bool)
 
void setDrafts (const QString &)
 
void setEmailAliases (const QStringList &aliases)
 
void setFcc (const QString &)
 
void setFullName (const QString &)
 
void setIdentityName (const QString &name)
 
void setIsDefault (bool flag)
 
void setOrganization (const QString &)
 
void setPgpAutoEncrypt (bool)
 
void setPgpAutoSign (bool)
 
void setPGPEncryptionKey (const QByteArray &key)
 
void setPGPSigningKey (const QByteArray &key)
 
void setPreferredCryptoMessageFormat (const QString &)
 
void setPrimaryEmailAddress (const QString &email)
 
void setProperty (const QString &key, const QVariant &value)
 
void setReplyToAddr (const QString &)
 
void setSignature (const Signature &sig)
 
void setSMIMEEncryptionKey (const QByteArray &key)
 
void setSMIMESigningKey (const QByteArray &key)
 
void setTemplates (const QString &)
 
void setTransport (const QString &)
 
void setUoid (uint aUoid)
 
void setVCardFile (const QString &)
 
void setXFace (const QString &)
 
void setXFaceEnabled (const bool)
 
Signature & signature ()
 
bool signatureIsInlinedHtml () const
 
QString signatureText (bool *ok=nullptr) const
 
QByteArray smimeEncryptionKey () const
 
QByteArray smimeSigningKey () const
 
QString templates () const
 
QString transport () const
 
uint uoid () const
 
QString vCardFile () const
 
void writeConfig (KConfigGroup &) const
 
QString xface () const
 

Static Public Member Functions

static bool canDecode (const QMimeData *)
 
static Identity fromMimeData (const QMimeData *)
 
static QString mimeDataType ()
 
static const Identity & null ()
 

Protected Member Functions

void setSignatureFile (const QString &)
 
void setSignatureInlineText (const QString &)
 
QString signatureFile () const
 
QString signatureInlineText () const
 
bool signatureIsCommand () const
 
bool signatureIsInline () const
 
bool signatureIsPlainFile () const
 
bool useSignatureFile () const
 
QString verifyAkonadiId (const QString &str) const
 

Protected Attributes

bool mIsDefault
 
QHash< QString, QVariant > mPropertiesMap
 
Signature mSignature
 

Friends

KIDENTITYMANAGEMENT_EXPORT QDataStream & operator<< (QDataStream &stream, const KIdentityManagement::Identity &ident)
 
KIDENTITYMANAGEMENT_EXPORT QDataStream & operator>> (QDataStream &stream, KIdentityManagement::Identity &ident)
 

Detailed Description

User identity information.

Definition at line 77 of file identity.h.

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

Constructor.

Definition at line 39 of file identity.cpp.

Member Function Documentation

bool Identity::attachVcard ( ) const
Since
4.10

Definition at line 435 of file identity.cpp.

QString Identity::autocorrectionLanguage ( ) const
Since
4.10

Definition at line 528 of file identity.cpp.

QString Identity::bcc ( ) const

email addresses for the BCC: field

Definition at line 445 of file identity.cpp.

QString Identity::cc ( ) const

email addresses for the CC: field

Since
4.9

Definition at line 450 of file identity.cpp.

QString Identity::defaultDomainName ( ) const
Since
4.14

Definition at line 755 of file identity.cpp.

QString Identity::dictionary ( ) const

Dictionary which should be used for spell checking.

Note that this is the localized language name (e.g. "British English"), not the language code or dictionary name!

Definition at line 470 of file identity.cpp.

bool Identity::disabledFcc ( ) const
Since
4.11

Definition at line 710 of file identity.cpp.

QString Identity::drafts ( ) const

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

Definition at line 481 of file identity.cpp.

const QStringList Identity::emailAliases ( ) const

email address aliases

Since
4.6

Definition at line 425 of file identity.cpp.

QString Identity::fcc ( ) const

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

Definition at line 487 of file identity.cpp.

QString Identity::fullEmailAddr ( ) const

email address in the format "username <[email protected]>" suitable for the "From:" field of email messages.

Definition at line 324 of file identity.cpp.

QString Identity::fullName ( ) const

Full name of the user.

Definition at line 385 of file identity.cpp.

QString Identity::identityName ( ) const

Identity/nickname for this collection.

Definition at line 360 of file identity.cpp.

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

Definition at line 375 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 65 of file identity.cpp.

bool Identity::mailingAllowed ( ) const

Tests if there are enough values set to allow mailing.

Definition at line 129 of file identity.cpp.

bool Identity::matchesEmailAddress ( const QString &  addr) const
Parameters
addrthe email address to check
Returns
true if this identity contains the email address addr, either as primary address or as alias
Since
4.6

Definition at line 688 of file identity.cpp.

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

used for comparison

Definition at line 308 of file identity.cpp.

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

used for sorting

Definition at line 244 of file identity.cpp.

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

used for sorting

Definition at line 266 of file identity.cpp.

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

used for comparison

Definition at line 276 of file identity.cpp.

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

used for sorting

Definition at line 255 of file identity.cpp.

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

used for sorting

Definition at line 271 of file identity.cpp.

QString Identity::organization ( ) const

The user's organization (optional)

Definition at line 390 of file identity.cpp.

bool Identity::pgpAutoEncrypt ( ) const
Since
5.4

Definition at line 740 of file identity.cpp.

bool Identity::pgpAutoSign ( ) const
Since
4.12

Definition at line 725 of file identity.cpp.

QByteArray Identity::pgpEncryptionKey ( ) const

The user's OpenPGP encryption key.

Definition at line 395 of file identity.cpp.

QByteArray Identity::pgpSigningKey ( ) const

The user's OpenPGP signing key.

Definition at line 400 of file identity.cpp.

QString Identity::primaryEmailAddress ( ) const

primary email address (without the user name - only [email protected]).

The primary email address is used for all outgoing mail.

Since
4.6

Definition at line 420 of file identity.cpp.

QVariant Identity::property ( const QString &  key) const

Get random properties.

Parameters
keythe key of the property to get

Definition at line 315 of file identity.cpp.

void Identity::readConfig ( const KConfigGroup &  config)

Read configuration from config.

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

Definition at line 98 of file identity.cpp.

QString Identity::replyToAddr ( ) const

email address for the ReplyTo: field

Definition at line 440 of file identity.cpp.

void Identity::setIdentityName ( const QString &  name)

Identity/nickname for this collection.

Definition at line 554 of file identity.cpp.

void Identity::setIsDefault ( bool  flag)

Set whether this identity is the default identity.

Since this affects all other identities, 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 659 of file identity.cpp.

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

void Identity::setUoid ( uint  aUoid)

set the uiod

Parameters
aUoidthe uoid to set

Definition at line 549 of file identity.cpp.

QString Identity::signatureFile ( ) const
protected

name of the signature file (with path)

Definition at line 523 of file identity.cpp.

QString Identity::signatureInlineText ( ) const
protected

inline signature

Definition at line 518 of file identity.cpp.

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

Definition at line 498 of file identity.cpp.

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

Definition at line 508 of file identity.cpp.

bool Identity::signatureIsInlinedHtml ( ) const
Since
4.1
Returns
true if the inlined signature is html formatted

Definition at line 370 of file identity.cpp.

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

Definition at line 503 of file identity.cpp.

QString Identity::signatureText ( bool *  ok = nullptr) 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.
Parameters
okif a valid bool pointer, it is set to true or false depending on whether the signature could successfully be obtained.

Definition at line 365 of file identity.cpp.

QByteArray Identity::smimeEncryptionKey ( ) const

The user's S/MIME encryption key.

Definition at line 405 of file identity.cpp.

QByteArray Identity::smimeSigningKey ( ) const

The user's S/MIME signing key.

Definition at line 410 of file identity.cpp.

QString Identity::templates ( ) const

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

Definition at line 475 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 493 of file identity.cpp.

uint Identity::uoid ( ) const

Unique Object Identifier for this identity.

Definition at line 380 of file identity.cpp.

bool Identity::useSignatureFile ( ) const
protected

Inline or signature from a file.

Definition at line 513 of file identity.cpp.

QString Identity::vCardFile ( ) const

vCard to attach to outgoing emails

Definition at line 430 of file identity.cpp.

QString Identity::verifyAkonadiId ( const QString &  str) const
protected

during migration when it failed it can be a string => not a qlonglong akonadi::id => fix it

Definition at line 765 of file identity.cpp.

void Identity::writeConfig ( KConfigGroup &  config) const

Write configuration to config.

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

Definition at line 117 of file identity.cpp.

QString Identity::xface ( ) const

a X-Face header for this identity

Definition at line 465 of file identity.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 5 2020 23:09:19 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.