KEMailSettings Class Reference

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. More...

#include <kemailsettings.h>

List of all members.

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 ()
QString	currentProfileName () const
QString	defaultProfileName () const
QString	getSetting (KEMailSettings::Setting s) const
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.

Author:

Alex Zepeda zipzippy@sonic.net

Definition at line 46 of file kemailsettings.h.

---

Member Enumeration Documentation

enum KEMailSettings::Extension

The various extensions allowed.

Enumerator:

POP3
SMTP
OTHER

Definition at line 81 of file kemailsettings.h.

enum KEMailSettings::Setting

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:

ClientProgram
ClientTerminal
RealName
EmailAddress
ReplyToAddress
Organization
OutServer
OutServerLogin
OutServerPass
OutServerType
OutServerCommand
OutServerTLS
InServer
InServerLogin
InServerPass
InServerType
InServerMBXType
InServerTLS

Definition at line 57 of file kemailsettings.h.

---

Constructor & Destructor Documentation

KEMailSettings::KEMailSettings

(

)

Default constructor, just sets things up.

Definition at line 237 of file kemailsettings.cpp.

KEMailSettings::~KEMailSettings

(

)

Default destructor, nothing to see here.

Definition at line 266 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

Definition at line 227 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 43 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 48 of file kemailsettings.cpp.

QStringList KEMailSettings::profiles

(

)

const

List of profiles available.

Returns:

the list of profiles

Definition at line 232 of file kemailsettings.cpp.

void KEMailSettings::setDefault

(

const QString &

def

)

Sets a new default.

Parameters:

def	the new default

Definition at line 207 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 215 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 127 of file kemailsettings.cpp.

---

The documentation for this class was generated from the following files:

• kemailsettings.h
• kemailsettings.cpp