KEMailSettings

Search for usage in LXR

KEMailSettings Class Reference

#include <KEMailSettings>

Public Types

enum  Setting {
  ClientProgram , ClientTerminal , RealName , EmailAddress ,
  ReplyToAddress , Organization
}
 

Public Member Functions

 KEMailSettings ()
 
 KEMailSettings (const KEMailSettings &)=delete
 
 ~KEMailSettings ()
 
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.nosp@m.ppy@.nosp@m.sonic.nosp@m..net

Definition at line 28 of file kemailsettings.h.

Member Enumeration Documentation

◆ Setting

The list of settings that I thought of when I wrote this class.

See also
getSetting()
setSetting()

Definition at line 38 of file kemailsettings.h.

Constructor & Destructor Documentation

◆ KEMailSettings()

KEMailSettings::KEMailSettings ( )

Default constructor, just sets things up and sets the default profile as the current profile.

Definition at line 113 of file kemailsettings.cpp.

◆ ~KEMailSettings()

KEMailSettings::~KEMailSettings ( )

Default destructor, nothing to see here.

Definition at line 145 of file kemailsettings.cpp.

Member Function Documentation

◆ defaultProfileName()

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 28 of file kemailsettings.cpp.

◆ getSetting()

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 33 of file kemailsettings.cpp.

◆ profiles()

QStringList KEMailSettings::profiles ( ) const

List of profiles available.

Returns
the list of profiles

Definition at line 108 of file kemailsettings.cpp.

◆ setDefault()

void KEMailSettings::setDefault ( const QString & def)

Sets a new default.

Parameters
defthe new default

Definition at line 90 of file kemailsettings.cpp.

◆ setProfile()

void KEMailSettings::setProfile ( const QString & s)

Change the current profile.

Parameters
sthe name of the new profile

Definition at line 97 of file kemailsettings.cpp.

◆ setSetting()

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 58 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-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:47:04 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.