KEMailSettings

KEMailSettings Class Reference

#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
 
KEMailSettingsoperator= (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.

Author
Alex Zepeda zipzi[email protected][email protected][email protected]sonic[email protected].net

Definition at line 28 of file kemailsettings.h.

Member Enumeration Documentation

The various extensions allowed.

Definition at line 91 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 
Deprecated:
since 5.0
OutServerCommand 
Deprecated:
since 5.0
OutServerTLS 
Deprecated:
since 5.0
InServerType 
Deprecated:
since 5.0
InServerMBXType 
Deprecated:
since 5.0
InServerTLS 
Deprecated:
since 5.0

Definition at line 41 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 220 of file kemailsettings.cpp.

KEMailSettings::~KEMailSettings ( )

Default destructor, nothing to see here.

Definition at line 252 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 209 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 25 of file kemailsettings.cpp.

QString KEMailSettings::getSetting ( KEMailSettings::Setting  s) const

Get one of the predefined "basic" settings.

Parameters
sthe setting to get
Returns
the value of the setting, or QString() if not set

Definition at line 30 of file kemailsettings.cpp.

QStringList KEMailSettings::profiles ( ) const

List of profiles available.

Returns
the list of profiles

Definition at line 215 of file kemailsettings.cpp.

void KEMailSettings::setDefault ( const QString def)

Sets a new default.

Parameters
defthe new default

Definition at line 189 of file kemailsettings.cpp.

void KEMailSettings::setProfile ( const QString s)

Change the current profile.

Parameters
sthe name of the new profile

Definition at line 197 of file kemailsettings.cpp.

void KEMailSettings::setSetting ( KEMailSettings::Setting  s,
const QString v 
)

Set one of the predefined "basic" settings.

Parameters
sthe setting to set
vthe new value of the setting, or QString() to unset

Definition at line 100 of file kemailsettings.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Sep 21 2020 22:48:36 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.