/usr/include/kpimidentities/identity.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | /*
Copyright (c) 2002-2004 Marc Mutz <mutz@kde.org>
Copyright (c) 2007 Tom Albers <tomalbers@kde.nl>
Author: Stefan Taferner <taferner@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef KPIMIDENTITES_IDENTITY_H
#define KPIMIDENTITES_IDENTITY_H
#include "kpimidentities_export.h"
#include "signature.h"
#include <kdemacros.h>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QList>
#include <QtCore/QHash>
#include <QtCore/QVariant>
namespace KPIMIdentities
{
class Identity;
class Signature;
}
class KConfigGroup;
class QDataStream;
class QMimeData;
namespace KPIMIdentities
{
static const char s_uoid[] = "uoid";
static const char s_identity[] = "Identity";
static const char s_name[] = "Name";
static const char s_organization[] = "Organization";
static const char s_pgps[] = "PGP Signing Key";
static const char s_pgpe[] = "PGP Encryption Key";
static const char s_smimes[] = "SMIME Signing Key";
static const char s_smimee[] = "SMIME Encryption Key";
static const char s_prefcrypt[] = "Preferred Crypto Message Format";
static const char s_email[] = "Email Address"; // TODO: KDE5: Rename to s_primaryEmail
static const char s_replyto[] = "Reply-To Address";
static const char s_bcc[] = "Bcc";
static const char s_vcard[] = "VCardFile";
static const char s_transport[] = "Transport";
static const char s_fcc[] = "Fcc";
static const char s_drafts[] = "Drafts";
static const char s_templates[] = "Templates";
static const char s_dict[] = "Dictionary";
static const char s_xface[] = "X-Face";
static const char s_xfaceenabled[] = "X-FaceEnabled";
static const char s_signature[] = "Signature";
static const char s_emailAliases[] = "Email Aliases";
KPIMIDENTITIES_EXPORT QDataStream &operator<<
( QDataStream &stream, const KPIMIdentities::Identity &ident );
KPIMIDENTITIES_EXPORT QDataStream &operator>>
( QDataStream &stream, KPIMIdentities::Identity &ident );
/** User identity information */
class KPIMIDENTITIES_EXPORT Identity
{
// only the identity manager should be able to construct and
// destruct us, but then we get into problems with using
// QValueList<Identity> and especially qHeapSort().
friend class IdentityManager;
friend KPIMIDENTITIES_EXPORT QDataStream &operator<<
( QDataStream &stream, const KPIMIdentities::Identity &ident );
friend KPIMIDENTITIES_EXPORT QDataStream &operator>>
( QDataStream &stream, KPIMIdentities::Identity &ident );
public:
typedef QList<Identity> List;
/** Constructor */
explicit Identity( const QString &id=QString(),
const QString &realName=QString(),
const QString &emailAddr=QString(),
const QString &organization=QString(),
const QString &replyToAddress=QString() );
/** Destructor */
~Identity();
/** used for comparison */
bool operator== ( const Identity &other ) const;
/** used for comparison */
bool operator!= ( const Identity &other ) const;
/** used for sorting */
bool operator< ( const Identity &other ) const;
/** used for sorting */
bool operator> ( const Identity &other ) const;
/** used for sorting */
bool operator<= ( const Identity &other ) const;
/** used for sorting */
bool operator>= ( const Identity &other ) const;
/** Tests if there are enough values set to allow mailing */
bool mailingAllowed() const;
/** Identity/nickname for this collection */
QString identityName() const;
/** Identity/nickname for this collection */
void setIdentityName( const QString &name );
/** @return whether this identity is the default identity */
bool isDefault() const;
/** Unique Object Identifier for this identity */
uint uoid() const;
/** Full name of the user */
QString fullName() const;
void setFullName( const QString& );
/** The user's organization (optional) */
QString organization() const;
void setOrganization( const QString& );
/** The user's OpenPGP encryption key */
QByteArray pgpEncryptionKey() const;
void setPGPEncryptionKey( const QByteArray &key );
/** The user's OpenPGP signing key */
QByteArray pgpSigningKey() const;
void setPGPSigningKey( const QByteArray &key );
/** The user's S/MIME encryption key */
QByteArray smimeEncryptionKey() const;
void setSMIMEEncryptionKey( const QByteArray &key );
/** The user's S/MIME signing key */
QByteArray smimeSigningKey() const;
void setSMIMESigningKey( const QByteArray &key );
QString preferredCryptoMessageFormat() const;
void setPreferredCryptoMessageFormat( const QString& );
/**
* email address (without the user name - only name\@host)
* @deprecated Use the primary email address or aliases, depending on your usecase
* @sa primaryEmailAddress(), setPrimaryEmailAddress(), emailAliases(), setEmailAliases(),
* matchesEmailAddress()
*/
KDE_DEPRECATED QString emailAddr() const;
KDE_DEPRECATED void setEmailAddr( const QString& );
/**
* primary email address (without the user name - only name\@host).
* The primary email address is used for all outgoing mail.
*
* @since 4.6
*/
QString primaryEmailAddress() const;
void setPrimaryEmailAddress( const QString & email );
/**
* email address aliases
*
* @since 4.6
*/
const QStringList emailAliases() const;
void setEmailAliases( const QStringList & aliases );
/**
* @return true if this identity contains the email address @p addr, either as primary address
* or as alias
*
* @since 4.6
*/
bool matchesEmailAddress( const QString & addr ) const;
/** vCard to attach to outgoing emails */
QString vCardFile() const;
void setVCardFile( const QString& );
/** email address in the format "username <name@host>" suitable
for the "From:" field of email messages. */
QString fullEmailAddr() const;
/** email address for the ReplyTo: field */
QString replyToAddr() const;
void setReplyToAddr( const QString& );
/** email addresses for the BCC: field */
QString bcc() const;
void setBcc( const QString& );
void setSignature( const Signature &sig );
Signature &signature(); /* _not_ const! */
/** @return the signature with '-- \n' prepended to it if it is not
present already.
No newline in front of or after the signature is added.
If @p ok is a valid bool pointer, @p ok is set to true or false depending
on whether the signature could successfully be obtained.
*/
QString signatureText( bool *ok = 0 ) const;
/**
* @since 4.1
* @return true if the inlined signature is html formatted
*/
bool signatureIsInlinedHtml() const;
/** The transport that is set for this identity. Used to link a
transport with an identity. */
QString transport() const;
void setTransport( const QString& );
/** The folder where sent messages from this identity will be
stored by default. */
QString fcc() const;
void setFcc( const QString& );
/** 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.
*/
QString drafts() const;
void setDrafts( const QString& );
/** 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.
*/
QString templates() const;
void setTemplates( const QString& );
/**
* 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!
*/
QString dictionary() const;
void setDictionary( const QString& );
/** a X-Face header for this identity */
QString xface() const;
void setXFace( const QString& );
bool isXFaceEnabled() const;
void setXFaceEnabled( const bool );
/** Get random properties */
QVariant property( const QString &key ) const;
/** Set random properties, when @p value is empty (for QStrings) or null,
the property is deleted. */
void setProperty( const QString &key, const QVariant &value );
static const Identity &null();
/** Returns true when the identity contains no values, all null values or
only empty values */
bool isNull() const;
static QString mimeDataType();
static bool canDecode( const QMimeData* );
void populateMimeData( QMimeData* );
static Identity fromMimeData( const QMimeData* );
/** Read configuration from config. Group must be preset (or use
KConfigGroup). Called from IdentityManager. */
void readConfig( const KConfigGroup & );
/** Write configuration to config. Group must be preset (or use
KConfigGroup). Called from IdentityManager. */
void writeConfig( KConfigGroup & ) const;
/** 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
<pre>
kmkernel->identityManager()->setAsDefault( name_of_default )
</pre>
instead. */
void setIsDefault( bool flag );
/** set the uiod */
void setUoid( uint aUoid );
protected:
/** @return true if the signature is read from the output of a command */
bool signatureIsCommand() const;
/** @return true if the signature is read from a text file */
bool signatureIsPlainFile() const;
/** @return true if the signature was specified directly */
bool signatureIsInline() const;
/** name of the signature file (with path) */
QString signatureFile() const;
void setSignatureFile( const QString& );
/** inline signature */
QString signatureInlineText() const;
void setSignatureInlineText( const QString& );
/** Inline or signature from a file */
bool useSignatureFile() const;
Signature mSignature;
bool mIsDefault;
QHash<QString,QVariant> mPropertiesMap;
};
}
#endif /*kpim_identity_h*/
|