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
|
/*
SPDX-FileCopyrightText: 2000 Alex Zepeda <zipzippy@sonic.net>
SPDX-License-Identifier: BSD-2-Clause
*/
#ifndef _KEMAILSETTINGS_H
#define _KEMAILSETTINGS_H
#include <QCoreApplication> // Q_DECLARE_TR_FUNCTIONS
#include <QStringList>
#include <kconfigcore_export.h>
class KEMailSettingsPrivate;
/**
* \class KEMailSettings kemailsettings.h <KEMailSettings>
*
* This is just a small class to facilitate accessing e-mail settings in
* a sane way, and allowing any program to manage multiple e-mail
* profiles effortlessly
*
* The default profile is automatically selected in the constructor.
*
* @author Alex Zepeda zipzippy@sonic.net
**/
class KCONFIGCORE_EXPORT KEMailSettings
{
Q_DECLARE_TR_FUNCTIONS(KEMailSettings)
public:
/**
* The list of settings that I thought of when I wrote this
* class. Any extra settings thought of later can be accessed
* easily with getExtendedSetting and setExtendedSetting.
* @see getSetting()
* @see setSetting()
* @see getExtendedSetting()
* @see setExtendedSetting()
**/
enum Setting {
ClientProgram,
ClientTerminal,
RealName,
EmailAddress,
ReplyToAddress,
Organization,
OutServer,
OutServerLogin,
OutServerPass,
#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0
*/
OutServerType,
/**
* @deprecated since 5.0
*/
OutServerCommand,
/**
* @deprecated since 5.0
*/
OutServerTLS,
#else
OutServerType_DEPRECATED_DO_NOT_USE,
OutServerCommand_DEPRECATED_DO_NOT_USE,
OutServerTLS_DEPRECATED_DO_NOT_USE,
#endif
InServer,
InServerLogin,
InServerPass,
#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
* @deprecated since 5.0
*/
InServerType,
/**
* @deprecated since 5.0
*/
InServerMBXType,
/**
* @deprecated since 5.0
*/
InServerTLS
#endif
};
/**
* The various extensions allowed.
**/
enum Extension {
POP3,
SMTP,
OTHER
};
/**
* Default constructor, just sets things up and sets the default profile
* as the current profile
**/
KEMailSettings();
KEMailSettings(const KEMailSettings &) = delete;
KEMailSettings& operator=(const KEMailSettings &) = delete;
/**
* Default destructor, nothing to see here.
**/
~KEMailSettings();
/**
* List of profiles available.
* @return the list of profiles
**/
QStringList profiles() const;
#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 0)
/**
* Returns the name of the current profile.
* @returns what profile we're currently using
* @deprecated Since 5.0
**/
KCONFIGCORE_DEPRECATED_VERSION(5, 0, "API planned to be changed")
QString currentProfileName() const;
// see https://git.reviewboard.kde.org/r/111910/
#endif
/**
* Change the current profile.
* @param s the name of the new profile
**/
void setProfile(const QString &s);
/**
* Returns the name of the default profile.
* @returns the name of the one that's currently default QString() if none
**/
QString defaultProfileName() const;
/**
* Sets a new default.
* @param def the new default
**/
void setDefault(const QString &def);
/**
* Get one of the predefined "basic" settings.
* @param s the setting to get
* @return the value of the setting, or QString() if not
* set
**/
QString getSetting(KEMailSettings::Setting s) const;
/**
* Set one of the predefined "basic" settings.
* @param s the setting to set
* @param v the new value of the setting, or QString() to
* unset
**/
void setSetting(KEMailSettings::Setting s, const QString &v);
private:
KEMailSettingsPrivate *const p;
};
#endif
|
