#include <KEMailSettings>
Public Types | |
| enum | Extension { POP3, SMTP, OTHER } |
| enum | Setting { ClientProgram, ClientTerminal, RealName, EmailAddress, ReplyToAddress, Organization, OutServer, OutServerLogin, OutServerPass, OutServerType, OutServerCommand, OutServerTLS, InServer, InServerLogin, InServerPass, InServerType, InServerMBXType, InServerTLS } |
Public Member Functions | |
| KEMailSettings () | |
| KEMailSettings (const KEMailSettings &)=delete | |
| ~KEMailSettings () | |
| QString | currentProfileName () const |
| QString | defaultProfileName () const |
| QString | getSetting (KEMailSettings::Setting s) const |
| KEMailSettings & | operator= (const KEMailSettings &)=delete |
| QStringList | profiles () const |
| void | setDefault (const QString &def) |
| void | setProfile (const QString &s) |
| void | setSetting (KEMailSettings::Setting s, const QString &v) |
Detailed Description
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.
Definition at line 49 of file kemailsettings.h.
Member Enumeration Documentation
The various extensions allowed.
Definition at line 112 of file kemailsettings.h.
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 also
- getSetting()
- setSetting()
- getExtendedSetting()
- setExtendedSetting()
| Enumerator | |
|---|---|
| OutServerType |
|
| OutServerCommand |
|
| OutServerTLS |
|
| InServerType |
|
| InServerMBXType |
|
| InServerTLS |
|
Definition at line 62 of file kemailsettings.h.
Constructor & Destructor Documentation
| KEMailSettings::KEMailSettings | ( | ) |
Default constructor, just sets things up and sets the default profile as the current profile.
Definition at line 240 of file kemailsettings.cpp.
| KEMailSettings::~KEMailSettings | ( | ) |
Default destructor, nothing to see here.
Definition at line 272 of file kemailsettings.cpp.
Member Function Documentation
| QString KEMailSettings::currentProfileName | ( | ) | const |
Returns the name of the current profile.
- Returns
- what profile we're currently using
- Deprecated:
- Since 5.0
Definition at line 229 of file kemailsettings.cpp.
| QString KEMailSettings::defaultProfileName | ( | ) | const |
Returns the name of the default profile.
- Returns
- the name of the one that's currently default QString() if none
Definition at line 45 of file kemailsettings.cpp.
| QString KEMailSettings::getSetting | ( | KEMailSettings::Setting | s | ) | const |
Get one of the predefined "basic" settings.
- Parameters
-
s the setting to get
- Returns
- the value of the setting, or QString() if not set
Definition at line 50 of file kemailsettings.cpp.
| QStringList KEMailSettings::profiles | ( | ) | const |
List of profiles available.
- Returns
- the list of profiles
Definition at line 235 of file kemailsettings.cpp.
| void KEMailSettings::setDefault | ( | const QString & | def | ) |
Sets a new default.
- Parameters
-
def the new default
Definition at line 209 of file kemailsettings.cpp.
| void KEMailSettings::setProfile | ( | const QString & | s | ) |
Change the current profile.
- Parameters
-
s the name of the new profile
Definition at line 217 of file kemailsettings.cpp.
| void KEMailSettings::setSetting | ( | KEMailSettings::Setting | s, |
| const QString & | v | ||
| ) |
Set one of the predefined "basic" settings.
- Parameters
-
s the setting to set v the new value of the setting, or QString() to unset
Definition at line 120 of file kemailsettings.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jan 22 2020 05:40:25 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.