KPIMIdentities::Identity Class Reference

#include <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	attachVcard () const
QString	autocorrectionLanguage () const
QString	bcc () const
QString	cc () const
QString	defaultDomainName () const
QString	dictionary () const
bool	disabledFcc () const
QString	drafts () const
KPIMIDENTITIES_DEPRECATED QString	emailAddr () 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	pgpAutoSign () const
QByteArray	pgpEncryptionKey () const
QByteArray	pgpSigningKey () const
void	populateMimeData (QMimeData *)
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 &)
KPIMIDENTITIES_DEPRECATED void	setEmailAddr (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	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=0) 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
KPIMIDENTITIES_EXPORT QDataStream &	operator<< (QDataStream &stream, const KPIMIdentities::Identity &ident)
KPIMIDENTITIES_EXPORT QDataStream &	operator>> (QDataStream &stream, KPIMIdentities::Identity &ident)

Detailed Description

User identity information.

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

Identity::~Identity

(

)

Destructor.

Definition at line 53 of file identity.cpp.

Member Function Documentation

bool Identity::attachVcard

(

)

const

Since

4.10

Definition at line 394 of file identity.cpp.

QString Identity::autocorrectionLanguage

(

)

const

Since

4.10

Definition at line 491 of file identity.cpp.

QString Identity::bcc

(

)

const

email addresses for the BCC: field

Definition at line 404 of file identity.cpp.

QString Identity::cc

(

)

const

email addresses for the CC: field

Since

4.9

Definition at line 409 of file identity.cpp.

QString Identity::defaultDomainName

(

)

const

Since

4.14

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

bool Identity::disabledFcc

(

)

const

Since

4.11

Definition at line 688 of file identity.cpp.

QString Identity::drafts

(

)

const

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

TODO: KDE5 Change QString to int as the folder is an akonadi collection id.

Definition at line 444 of file identity.cpp.

QString Identity::emailAddr

(

)

const

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

Deprecated:

Use the primary email address or aliases, depending on your usecase

See also

primaryEmailAddress(), setPrimaryEmailAddress(), emailAliases(), setEmailAliases(), matchesEmailAddress()

Definition at line 374 of file identity.cpp.

const QStringList Identity::emailAliases

(

)

const

email address aliases

Since

4.6

Definition at line 384 of file identity.cpp.

QString Identity::fcc

(

)

const

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

Definition at line 450 of file identity.cpp.

QString Identity::fullEmailAddr

(

void

)

const

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

Definition at line 278 of file identity.cpp.

QString Identity::fullName

(

)

const

Full name of the user.

Definition at line 339 of file identity.cpp.

QString Identity::identityName

(

)

const

Identity/nickname for this collection.

Definition at line 314 of file identity.cpp.

bool Identity::isDefault

(

)

const

Returns

whether this identity is the default identity

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

bool Identity::mailingAllowed

(

)

const

Tests if there are enough values set to allow mailing.

Definition at line 121 of file identity.cpp.

bool Identity::matchesEmailAddress

(

const QString &

addr

)

const

Parameters

addr	the 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 652 of file identity.cpp.

bool Identity::operator!=

(

const Identity &

other

)

const

used for comparison

Definition at line 266 of file identity.cpp.

bool Identity::operator<

(

const Identity &

other

)

const

used for sorting

Definition at line 228 of file identity.cpp.

bool Identity::operator<=

(

const Identity &

other

)

const

used for sorting

Definition at line 250 of file identity.cpp.

bool Identity::operator==

(

const Identity &

other

)

const

used for comparison

Definition at line 260 of file identity.cpp.

bool Identity::operator>

(

const Identity &

other

)

const

used for sorting

Definition at line 239 of file identity.cpp.

bool Identity::operator>=

(

const Identity &

other

)

const

used for sorting

Definition at line 255 of file identity.cpp.

QString Identity::organization

(

)

const

The user's organization (optional)

Definition at line 344 of file identity.cpp.

bool Identity::pgpAutoSign

(

)

const

Since

4.12

Definition at line 703 of file identity.cpp.

QByteArray Identity::pgpEncryptionKey

(

)

const

The user's OpenPGP encryption key.

Definition at line 349 of file identity.cpp.

QByteArray Identity::pgpSigningKey

(

)

const

The user's OpenPGP signing key.

Definition at line 354 of file identity.cpp.

QString Identity::primaryEmailAddress

(

)

const

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

The primary email address is used for all outgoing mail.

Since

4.6

Definition at line 379 of file identity.cpp.

QVariant Identity::property

(

const QString &

key

)

const

Get random properties.

Parameters

key	the key of the property to get

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

QString Identity::replyToAddr

(

)

const

email address for the ReplyTo: field

Definition at line 399 of file identity.cpp.

void Identity::setIdentityName

(

const QString &

name

)

Identity/nickname for this collection.

Definition at line 513 of file identity.cpp.

void Identity::setIsDefault

(

bool

flag

)

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

void Identity::setUoid

(

uint

aUoid

)

set the uiod

Parameters

aUoid

the uoid to set

Definition at line 508 of file identity.cpp.

QString Identity::signatureFile ( ) const

protected

name of the signature file (with path)

Definition at line 486 of file identity.cpp.

QString Identity::signatureInlineText ( ) const

protected

inline signature

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

bool Identity::signatureIsInline ( ) const

protected

Returns

true if the signature was specified directly

Definition at line 471 of file identity.cpp.

bool Identity::signatureIsInlinedHtml

(

)

const

Since

4.1

Returns

true if the inlined signature is html formatted

Definition at line 324 of file identity.cpp.

bool Identity::signatureIsPlainFile ( ) const

protected

Returns

true if the signature is read from a text file

Definition at line 466 of file identity.cpp.

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.

Parameters

ok	if a valid bool pointer, it is set to true or false depending on whether the signature could successfully be obtained.

Definition at line 319 of file identity.cpp.

QByteArray Identity::smimeEncryptionKey

(

)

const

The user's S/MIME encryption key.

Definition at line 359 of file identity.cpp.

QByteArray Identity::smimeSigningKey

(

)

const

The user's S/MIME signing key.

Definition at line 364 of file identity.cpp.

QString Identity::templates

(

)

const

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

TODO: KDE5 Change QString to int as the folder is an akonadi collection id.

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

uint Identity::uoid

(

)

const

Unique Object Identifier for this identity.

Definition at line 334 of file identity.cpp.

bool Identity::useSignatureFile ( ) const

protected

Inline or signature from a file.

Definition at line 476 of file identity.cpp.

QString Identity::vCardFile

(

)

const

vCard to attach to outgoing emails

Definition at line 389 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

remove it in kde5

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

QString Identity::xface

(

)

const

a X-Face header for this identity

Definition at line 424 of file identity.cpp.

---

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

• identity.h
• identity.cpp