KIdentityManagement

identity.h
1/*
2 SPDX-FileCopyrightText: 2002-2004 Marc Mutz <mutz@kde.org>
3 SPDX-FileCopyrightText: 2007 Tom Albers <tomalbers@kde.nl>
4 Author: Stefan Taferner <taferner@kde.org>
5
6 SPDX-License-Identifier: LGPL-2.0-or-later
7*/
8
9#pragma once
10
11#include "kidentitymanagementcore_export.h"
12#include "signature.h"
13
14#include <QHash>
15#include <QList>
16#include <QString>
17#include <QStringList>
18#include <QVariant>
19
20namespace KIdentityManagementCore
21{
22class Identity;
23}
24class KConfigGroup;
25class QDataStream;
26class QMimeData;
27
28namespace KIdentityManagementCore
29{
30static const char s_uoid[] = "uoid";
31static const char s_identity[] = "Identity";
32static const char s_name[] = "Name";
33static const char s_organization[] = "Organization";
34static const char s_pgps[] = "PGP Signing Key";
35static const char s_pgpe[] = "PGP Encryption Key";
36static const char s_smimes[] = "SMIME Signing Key";
37static const char s_smimee[] = "SMIME Encryption Key";
38static const char s_prefcrypt[] = "Preferred Crypto Message Format";
39static const char s_primaryEmail[] = "Email Address";
40static const char s_replyto[] = "Reply-To Address";
41static const char s_bcc[] = "Bcc";
42static const char s_cc[] = "Cc";
43static const char s_vcard[] = "VCardFile";
44static const char s_transport[] = "Transport";
45static const char s_fcc[] = "Fcc";
46static const char s_drafts[] = "Drafts";
47static const char s_templates[] = "Templates";
48static const char s_dict[] = "Dictionary";
49static const char s_xface[] = "X-Face";
50static const char s_xfaceenabled[] = "X-FaceEnabled";
51static const char s_face[] = "Face";
52static const char s_faceenabled[] = "FaceEnabled";
53static const char s_signature[] = "Signature";
54static const char s_emailAliases[] = "Email Aliases";
55static const char s_attachVcard[] = "Attach Vcard";
56static const char s_autocorrectionLanguage[] = "Autocorrection Language";
57static const char s_disabledFcc[] = "Disable Fcc";
58static const char s_encryptionOverride[] = "Override Encryption Defaults";
59static const char s_pgpautosign[] = "Pgp Auto Sign";
60static const char s_pgpautoencrypt[] = "Pgp Auto Encrypt";
61static const char s_warnnotsign[] = "Warn not Sign";
62static const char s_warnnotencrypt[] = "Warn not Encrypt";
63static const char s_defaultDomainName[] = "Default Domain";
64static const char s_autocryptEnabled[] = "Autocrypt";
65static const char s_autocryptPrefer[] = "Autocrypt Prefer";
66static const char s_activities[] = "Activities";
67static const char s_enabledActivities[] = "Enabled Activities";
68static const char s_spam[] = "Spam";
69static const char s_disabledSpam[] = "Disable Spam";
70
71KIDENTITYMANAGEMENTCORE_EXPORT QDataStream &operator<<(QDataStream &stream, const KIdentityManagementCore::Identity &ident);
72KIDENTITYMANAGEMENTCORE_EXPORT QDataStream &operator>>(QDataStream &stream, KIdentityManagementCore::Identity &ident);
73
74/** User identity information */
75class KIDENTITYMANAGEMENTCORE_EXPORT Identity
76{
77 Q_GADGET
78
79 Q_PROPERTY(bool mailingAllowed READ mailingAllowed)
80 Q_PROPERTY(QString identityName READ identityName WRITE setIdentityName)
81 Q_PROPERTY(QString fullName READ fullName WRITE setFullName)
82 Q_PROPERTY(QString organization READ organization WRITE setOrganization)
83 Q_PROPERTY(QByteArray pgpEncryptionKey READ pgpEncryptionKey WRITE setPGPEncryptionKey)
84 Q_PROPERTY(QByteArray pgpSigningKey READ pgpSigningKey WRITE setPGPSigningKey)
85 Q_PROPERTY(QByteArray smimeEncryptionKey READ smimeEncryptionKey WRITE setSMIMEEncryptionKey)
86 Q_PROPERTY(QByteArray smimeSigningKey READ smimeSigningKey WRITE setSMIMESigningKey)
87 Q_PROPERTY(QString preferredCryptoMessageFormat READ preferredCryptoMessageFormat WRITE setPreferredCryptoMessageFormat)
88 Q_PROPERTY(QString primaryEmailAddress READ primaryEmailAddress WRITE setPrimaryEmailAddress)
89 Q_PROPERTY(QStringList emailAliases READ emailAliases WRITE setEmailAliases)
90 Q_PROPERTY(QString vCardFile READ vCardFile WRITE setVCardFile)
91 Q_PROPERTY(QString fullEmailAddr READ fullEmailAddr)
92 Q_PROPERTY(QString replyToAddr READ replyToAddr WRITE setReplyToAddr)
93 Q_PROPERTY(QString bcc READ bcc WRITE setBcc)
94 Q_PROPERTY(QString cc READ cc WRITE setCc)
95 Q_PROPERTY(bool attachVcard READ attachVcard WRITE setAttachVcard)
96 Q_PROPERTY(QString autocorrectionLanguage READ autocorrectionLanguage WRITE setAutocorrectionLanguage)
97 Q_PROPERTY(bool disabledFcc READ disabledFcc WRITE setDisabledFcc)
98 Q_PROPERTY(bool pgpAutoSign READ pgpAutoSign WRITE setPgpAutoSign)
99 Q_PROPERTY(bool pgpAutoEncrypt READ pgpAutoEncrypt WRITE setPgpAutoEncrypt)
100 Q_PROPERTY(bool autocryptEnabled READ autocryptEnabled WRITE setAutocryptEnabled)
101 Q_PROPERTY(bool autocryptPrefer READ autocryptPrefer WRITE setAutocryptPrefer)
102 Q_PROPERTY(bool encryptionOverride READ encryptionOverride WRITE setEncryptionOverride)
103 Q_PROPERTY(bool warnNotSign READ warnNotSign WRITE setWarnNotSign)
104 Q_PROPERTY(bool warnNotEncrypt READ warnNotEncrypt WRITE setWarnNotEncrypt)
105 Q_PROPERTY(QString defaultDomainName READ defaultDomainName WRITE setDefaultDomainName)
106 Q_PROPERTY(Signature signature READ signature WRITE setSignature)
107 Q_PROPERTY(QString signatureText READ signatureText)
108 Q_PROPERTY(bool signatureIsInlinedHtml READ signatureIsInlinedHtml)
109 Q_PROPERTY(QString transport READ transport WRITE setTransport)
110 Q_PROPERTY(QString fcc READ fcc WRITE setFcc)
111 Q_PROPERTY(QString drafts READ drafts WRITE setDrafts)
112 Q_PROPERTY(QString templates READ templates WRITE setTemplates)
113 Q_PROPERTY(QString dictionary READ dictionary WRITE setDictionary)
114 Q_PROPERTY(QString xface READ xface WRITE setXFace)
115 Q_PROPERTY(bool isXFaceEnabled READ isXFaceEnabled WRITE setXFaceEnabled)
116 Q_PROPERTY(QString face READ face WRITE setFace)
117 Q_PROPERTY(bool isFaceEnabled READ isFaceEnabled WRITE setFaceEnabled)
118 Q_PROPERTY(uint uoid READ uoid CONSTANT)
119 Q_PROPERTY(bool isNull READ isNull)
120 Q_PROPERTY(QString spam READ spam WRITE setSpam)
121 Q_PROPERTY(bool disabledSpam READ disabledSpam WRITE setDisabledSpam)
122
123 // only the identity manager should be able to construct and
124 // destruct us, but then we get into problems with using
125 // QValueList<Identity> and especially qHeapSort().
126 friend class IdentityManager;
127
128 friend KIDENTITYMANAGEMENTCORE_EXPORT QDataStream &operator<<(QDataStream &stream, const KIdentityManagementCore::Identity &ident);
129 friend KIDENTITYMANAGEMENTCORE_EXPORT QDataStream &operator>>(QDataStream &stream, KIdentityManagementCore::Identity &ident);
130
131public:
132 using List = QList<Identity>;
133 using Id = uint;
134
135 /** Constructor */
136 explicit Identity(const QString &id = QString(),
137 const QString &realName = QString(),
138 const QString &emailAddr = QString(),
139 const QString &organization = QString(),
140 const QString &replyToAddress = QString());
141
142 /** used for comparison */
143 bool operator==(const Identity &other) const;
144
145 /** used for comparison */
146 bool operator!=(const Identity &other) const;
147
148 /** used for sorting */
149 bool operator<(const Identity &other) const;
150
151 /** used for sorting */
152 bool operator>(const Identity &other) const;
153
154 /** used for sorting */
155 bool operator<=(const Identity &other) const;
156
157 /** used for sorting */
158 bool operator>=(const Identity &other) const;
159
160 /** Tests if there are enough values set to allow mailing */
161 [[nodiscard]] bool mailingAllowed() const;
162
163 /** Identity/nickname for this collection */
164 [[nodiscard]] QString identityName() const;
165
166 /** Identity/nickname for this collection */
167 void setIdentityName(const QString &name);
168
169 /** @return whether this identity is the default identity */
170 [[nodiscard]] bool isDefault() const;
171
172 /** Unique Object Identifier for this identity */
173 [[nodiscard]] uint uoid() const;
174
175 /** Full name of the user */
176 [[nodiscard]] QString fullName() const;
177 void setFullName(const QString &);
178
179 /** The user's organization (optional) */
180 [[nodiscard]] QString organization() const;
181 void setOrganization(const QString &);
182
183 /** The user's OpenPGP encryption key */
184 [[nodiscard]] QByteArray pgpEncryptionKey() const;
185 void setPGPEncryptionKey(const QByteArray &key);
186
187 /** The user's OpenPGP signing key */
188 [[nodiscard]] QByteArray pgpSigningKey() const;
189 void setPGPSigningKey(const QByteArray &key);
190
191 /** The user's S/MIME encryption key */
192 [[nodiscard]] QByteArray smimeEncryptionKey() const;
193 void setSMIMEEncryptionKey(const QByteArray &key);
194
195 /** The user's S/MIME signing key */
196 [[nodiscard]] QByteArray smimeSigningKey() const;
197 void setSMIMESigningKey(const QByteArray &key);
198
199 [[nodiscard]] QString preferredCryptoMessageFormat() const;
200 void setPreferredCryptoMessageFormat(const QString &);
201
202 /**
203 * The primary email address (without the user name - only name\@host).
204 *
205 * This email address is used for all outgoing mail.
206 *
207 * @since 4.6
208 */
209 [[nodiscard]] QString primaryEmailAddress() const;
210 void setPrimaryEmailAddress(const QString &email);
211
212 /**
213 * The email address aliases
214 *
215 * @since 4.6
216 */
217 [[nodiscard]] const QStringList emailAliases() const;
218 void setEmailAliases(const QStringList &aliases);
219
220 /**
221 * @param addr the email address to check
222 * @return true if this identity contains the email address @p addr, either as primary address
223 * or as alias
224 *
225 * @since 4.6
226 */
227 [[nodiscard]] bool matchesEmailAddress(const QString &addr) const;
228
229 /** vCard to attach to outgoing emails */
230 [[nodiscard]] QString vCardFile() const;
231 void setVCardFile(const QString &);
232
233 /**
234 * The email address in the format "username <name@host>" suitable
235 * for the "From:" field of email messages.
236 */
237 [[nodiscard]] QString fullEmailAddr() const;
238
239 /** @return The email address for the ReplyTo: field */
240 [[nodiscard]] QString replyToAddr() const;
241 void setReplyToAddr(const QString &);
242
243 /** @return The email addresses for the BCC: field */
244 [[nodiscard]] QString bcc() const;
245 void setBcc(const QString &);
246
247 /**
248 * @return The email addresses for the CC: field
249 * @since 4.9
250 */
251 [[nodiscard]] QString cc() const;
252 void setCc(const QString &);
253
254 /**
255 * @return true if the Vcard of this identity should be attached to outgoing mail.
256 * @since 4.10
257 */
258 [[nodiscard]] bool attachVcard() const;
259 void setAttachVcard(bool attach);
260
261 /**
262 * @return The default language for spell checking of this identity.
263 * @since 4.10
264 */
265 [[nodiscard]] QString autocorrectionLanguage() const;
266 void setAutocorrectionLanguage(const QString &language);
267
268 /**
269 * @return true if Fcc is disabled for this identity.
270 * @since 4.11
271 */
272 [[nodiscard]] bool disabledFcc() const;
273 void setDisabledFcc(bool);
274
275 /**
276 * @return true if we should sign message sent by this identity by default.
277 * @since 4.12
278 */
279 [[nodiscard]] bool pgpAutoSign() const;
280 void setPgpAutoSign(bool);
281
282 /**
283 * @return true if we should encrypt message sent by this identity by default.
284 * @since 5.4
285 */
286 [[nodiscard]] bool pgpAutoEncrypt() const;
287 void setPgpAutoEncrypt(bool);
288
289 /**
290 * @return true if Autocrypt is enabled for this identity.
291 * @since 5.17
292 */
293 [[nodiscard]] bool autocryptEnabled() const;
294 void setAutocryptEnabled(const bool);
295
296 /**
297 * @return true if Autocrypt is preferred for this identity.
298 * @since 5.22
299 */
300 [[nodiscard]] bool autocryptPrefer() const;
301 void setAutocryptPrefer(const bool);
302
303 /**
304 * @return true if the warnNotSign and warnNotEncrypt identity configuration should
305 * overwrite the global app-wide configuration.
306 * @since 5.22
307 */
308 [[nodiscard]] bool encryptionOverride() const;
309 void setEncryptionOverride(const bool);
310
311 /**
312 * @return true if we should warn if parts of the message this identity is about to send are not signed.
313 * @since 5.22
314 */
315 [[nodiscard]] bool warnNotSign() const;
316 void setWarnNotSign(const bool);
317
318 /**
319 * @return true if we should warn if parts of the message this identity is about to send are not encrypted.
320 * @since 5.22
321 */
322 [[nodiscard]] bool warnNotEncrypt() const;
323 void setWarnNotEncrypt(const bool);
324
325 /**
326 * @return The default domain name
327 * @since 4.14
328 */
329 [[nodiscard]] QString defaultDomainName() const;
330 void setDefaultDomainName(const QString &domainName);
331
332 /**
333 * @return The signature of the identity.
334 *
335 * @warning This method is not const.
336 */
337 [[nodiscard]] Signature &signature();
338 void setSignature(const Signature &sig);
339
340 /**
341 * @return the signature with '-- \n' prepended to it if it is not
342 * present already.
343 * No newline in front of or after the signature is added.
344 * @param ok if a valid bool pointer, it is set to @c true or @c false depending
345 * on whether the signature could successfully be obtained.
346 */
347 [[nodiscard]] QString signatureText(bool *ok = nullptr) const;
348
349 /**
350 * @return true if the inlined signature is html formatted
351 * @since 4.1
352 */
353 [[nodiscard]] bool signatureIsInlinedHtml() const;
354
355 /** The transport that is set for this identity. Used to link a
356 transport with an identity. */
357 [[nodiscard]] QString transport() const;
358 void setTransport(const QString &);
359
360 /** The folder where sent messages from this identity will be
361 stored by default. */
362 [[nodiscard]] QString fcc() const;
363 void setFcc(const QString &);
364
365 /** The folder where draft messages from this identity will be
366 stored by default.
367 */
368 [[nodiscard]] QString drafts() const;
369 void setDrafts(const QString &);
370
371 /** The folder where template messages from this identity will be
372 stored by default.
373 */
374 [[nodiscard]] QString templates() const;
375 void setTemplates(const QString &);
376
377 /**
378 * Dictionary which should be used for spell checking
379 *
380 * Note that this is the localized language name (e.g. "British English"),
381 * _not_ the language code or dictionary name!
382 */
383 [[nodiscard]] QString dictionary() const;
384 void setDictionary(const QString &);
385
386 /** a X-Face header for this identity */
387 [[nodiscard]] QString xface() const;
388 void setXFace(const QString &);
389 [[nodiscard]] bool isXFaceEnabled() const;
390 void setXFaceEnabled(bool);
391
392 /** a Face header for this identity */
393 [[nodiscard]] QString face() const;
394 void setFace(const QString &);
395 [[nodiscard]] bool isFaceEnabled() const;
396 void setFaceEnabled(bool);
397
398 /** Get random properties
399 * @param key the key of the property to get
400 */
401 [[nodiscard]] QVariant property(const QString &key) const;
402 /** Set random properties, when @p value is empty (for QStrings) or null,
403 the property is deleted. */
404 void setProperty(const QString &key, const QVariant &value);
405
406 static const Identity &null();
407 /** Returns true when the identity contains no values, all null values or
408 only empty values */
409 [[nodiscard]] bool isNull() const;
410
411 [[nodiscard]] static QString mimeDataType();
412 [[nodiscard]] static bool canDecode(const QMimeData *);
413 void populateMimeData(QMimeData *) const;
414 static Identity fromMimeData(const QMimeData *);
415
416 /** Read configuration from config. Group must be preset (or use
417 KConfigGroup). Called from IdentityManager. */
418 void readConfig(const KConfigGroup &);
419
420 /** Write configuration to config. Group must be preset (or use
421 KConfigGroup). Called from IdentityManager. */
422 void writeConfig(KConfigGroup &) const;
423
424 /** Set whether this identity is the default identity. Since this
425 affects all other identities, too (most notably, the old default
426 identity), only the IdentityManager can change this.
427 You should use
428 <pre>
429 kmkernel->identityManager()->setAsDefault( name_of_default )
430 </pre>
431 instead. */
432 void setIsDefault(bool flag);
433
434 /**
435 * Set the uiod
436 * @param aUoid the uoid to set
437 */
438 void setUoid(uint aUoid);
439
440 [[nodiscard]] const QStringList activities() const;
441 void setActivities(const QStringList &a);
442
443 [[nodiscard]] bool enabledActivities() const;
444 void setEnabledActivities(bool a);
445
446 /** The folder where spam messages from this identity will be
447 stored by default. */
448 [[nodiscard]] QString spam() const;
449 void setSpam(const QString &);
450
451 /**
452 * @return true if Spam is disabled for this identity.
453 * @since 6.5
454 */
455 [[nodiscard]] bool disabledSpam() const;
456 void setDisabledSpam(bool);
457
458protected:
459 /** during migration when it failed it can be a string => not a qlonglong akonadi::id => fix it*/
460 [[nodiscard]] QString verifyAkonadiId(const QString &str) const;
461 /** @return true if the signature is read from the output of a command */
462 [[nodiscard]] bool signatureIsCommand() const;
463
464 /** @return true if the signature is read from a text file */
465 [[nodiscard]] bool signatureIsPlainFile() const;
466
467 /** @return true if the signature was specified directly */
468 [[nodiscard]] bool signatureIsInline() const;
469
470 /** name of the signature file (with path) */
471 [[nodiscard]] QString signatureFile() const;
472 void setSignatureFile(const QString &);
473
474 /** inline signature */
475 [[nodiscard]] QString signatureInlineText() const;
476 void setSignatureInlineText(const QString &);
477
478 /** Inline or signature from a file */
479 [[nodiscard]] bool useSignatureFile() const;
480
481 Signature mSignature;
482 bool mIsDefault = false;
483 QHash<QString, QVariant> mPropertiesMap;
484};
485}
486
487#ifndef UNITY_CMAKE_SUPPORT
488Q_DECLARE_METATYPE(KIdentityManagementCore::Identity)
489#endif
KIdentityManagementCore::Identity
User identity information.
Definition identity.h:76
KIdentityManagementCore::Identity::operator!=
bool operator!=(const Identity &other) const
used for comparison
Definition identity.cpp:279
KIdentityManagementCore::Identity::matchesEmailAddress
bool matchesEmailAddress(const QString &addr) const
Definition identity.cpp:713
KIdentityManagementCore::Identity::operator==
bool operator==(const Identity &other) const
used for comparison
Definition identity.cpp:250
KIdentityManagementCore::Identity::setUoid
void setUoid(uint aUoid)
Set the uiod.
Definition identity.cpp:535
KIdentityManagementCore::Identity::signatureFile
QString signatureFile() const
name of the signature file (with path)
Definition identity.cpp:510
KIdentityManagementCore::Identity::operator<=
bool operator<=(const Identity &other) const
used for sorting
Definition identity.cpp:240
KIdentityManagementCore::Identity::setIsDefault
void setIsDefault(bool flag)
Set whether this identity is the default identity.
Definition identity.cpp:670
KIdentityManagementCore::Identity::property
QVariant property(const QString &key) const
Get random properties.
Definition identity.cpp:286
KIdentityManagementCore::Identity::signatureInlineText
QString signatureInlineText() const
inline signature
Definition identity.cpp:505
KIdentityManagementCore::Identity::operator>=
bool operator>=(const Identity &other) const
used for sorting
Definition identity.cpp:245
KIdentityManagementCore::Identity::writeConfig
void writeConfig(KConfigGroup &) const
Write configuration to config.
Definition identity.cpp:113
KIdentityManagementCore::Identity::setProperty
void setProperty(const QString &key, const QVariant &value)
Set random properties, when value is empty (for QStrings) or null, the property is deleted.
Definition identity.cpp:522
KIdentityManagementCore::Identity::readConfig
void readConfig(const KConfigGroup &)
Read configuration from config.
Definition identity.cpp:87
KIdentityManagementCore::Identity::Identity
Identity(const QString &id=QString(), const QString &realName=QString(), const QString &emailAddr=QString(), const QString &organization=QString(), const QString &replyToAddress=QString())
Constructor.
Definition identity.cpp:25
KIdentityManagementCore::Identity::useSignatureFile
bool useSignatureFile() const
Inline or signature from a file.
Definition identity.cpp:500
KIdentityManagementCore::Identity::operator<
bool operator<(const Identity &other) const
used for sorting
Definition identity.cpp:218
KIdentityManagementCore::Identity::operator>
bool operator>(const Identity &other) const
used for sorting
Definition identity.cpp:229
KIdentityManagementCore::Identity::setIdentityName
void setIdentityName(const QString &name)
Identity/nickname for this collection.
Definition identity.cpp:540
KIdentityManagementCore::Identity::verifyAkonadiId
QString verifyAkonadiId(const QString &str) const
during migration when it failed it can be a string => not a qlonglong akonadi::id => fix it
Definition identity.cpp:880
KIdentityManagementCore::Signature
Abstraction of a signature (aka "footer").
Definition signature.h:61
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 12:04:10 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.