.TH "KEMailSettings" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
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.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kemailsettings.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBSetting\fP { \fBClientProgram\fP, \fBClientTerminal\fP, \fBRealName\fP, \fBEmailAddress\fP, \fBReplyToAddress\fP, \fBOrganization\fP, \fBOutServer\fP, \fBOutServerLogin\fP, \fBOutServerPass\fP, \fBOutServerType\fP, \fBOutServerCommand\fP, \fBOutServerTLS\fP, \fBInServer\fP, \fBInServerLogin\fP, \fBInServerPass\fP, \fBInServerType\fP, \fBInServerMBXType\fP, \fBInServerTLS\fP }"
.br
.ti -1c
.RI "enum \fBExtension\fP { \fBPOP3\fP, \fBSMTP\fP, \fBOTHER\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKEMailSettings\fP ()"
.br
.ti -1c
.RI "\fB~KEMailSettings\fP ()"
.br
.ti -1c
.RI "\fBQStringList\fP \fBprofiles\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBcurrentProfileName\fP () const "
.br
.ti -1c
.RI "void \fBsetProfile\fP (const \fBQString\fP &s)"
.br
.ti -1c
.RI "\fBQString\fP \fBdefaultProfileName\fP () const "
.br
.ti -1c
.RI "void \fBsetDefault\fP (const \fBQString\fP &def)"
.br
.ti -1c
.RI "\fBQString\fP \fBgetSetting\fP (\fBKEMailSettings::Setting\fP s)"
.br
.ti -1c
.RI "void \fBsetSetting\fP (\fBKEMailSettings::Setting\fP s, const \fBQString\fP &v)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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. 

\fBAuthor:\fP
.RS 4
Alex Zepeda zipzippy@sonic.net 
.RE
.PP

.PP
Definition at line 46 of file kemailsettings.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKEMailSettings::Setting\fP"
.PP
The list of settings that I thought of when I wrote this class. 
.PP
Any extra settings thought of later can be accessed easily with getExtendedSetting and setExtendedSetting. 
.PP
\fBSee also:\fP
.RS 4
\fBgetSetting()\fP 
.PP
\fBsetSetting()\fP 
.PP
getExtendedSetting() 
.PP
setExtendedSetting() 
.RE
.PP

.PP
Definition at line 57 of file kemailsettings.h.
.SS "enum \fBKEMailSettings::Extension\fP"
.PP
The various extensions allowed. 
.PP
Definition at line 81 of file kemailsettings.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KEMailSettings::KEMailSettings ()"
.PP
Default constructor, just sets things up. 
.PP
Definition at line 240 of file kemailsettings.cpp.
.PP
References defaultProfileName(), setDefault(), and setProfile().
.SS "KEMailSettings::~\fBKEMailSettings\fP ()"
.PP
Default destructor, nothing to see here. 
.PP
Definition at line 269 of file kemailsettings.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQStringList\fP KEMailSettings::profiles () const"
.PP
List of profiles available. 
.PP
\fBReturns:\fP
.RS 4
the list of profiles 
.RE
.PP

.PP
Definition at line 235 of file kemailsettings.cpp.
.SS "\fBQString\fP KEMailSettings::currentProfileName () const"
.PP
Returns the name of the current profile. 
.PP
\fBReturns:\fP
.RS 4
what profile we're currently using 
.RE
.PP

.PP
Definition at line 230 of file kemailsettings.cpp.
.SS "void KEMailSettings::setProfile (const \fBQString\fP & s)"
.PP
Change the current profile. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the name of the new profile 
.RE
.PP

.PP
Definition at line 217 of file kemailsettings.cpp.
.PP
References QString::append().
.PP
Referenced by KEMailSettings().
.SS "\fBQString\fP KEMailSettings::defaultProfileName () const"
.PP
Returns the name of the default profile. 
.PP
\fBReturns:\fP
.RS 4
the name of the one that's currently default QString::null if none 
.RE
.PP

.PP
Definition at line 44 of file kemailsettings.cpp.
.PP
Referenced by KEMailSettings().
.SS "void KEMailSettings::setDefault (const \fBQString\fP & def)"
.PP
Sets a new default. 
.PP
\fBParameters:\fP
.RS 4
\fIdef\fP the new default 
.RE
.PP

.PP
Definition at line 208 of file kemailsettings.cpp.
.PP
Referenced by KEMailSettings().
.SS "\fBQString\fP KEMailSettings::getSetting (\fBKEMailSettings::Setting\fP s)"
.PP
Get one of the predefined 'basic' settings. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the setting to get 
.RE
.PP
\fBReturns:\fP
.RS 4
the value of the setting, or QString::null if not set 
.RE
.PP

.PP
Definition at line 49 of file kemailsettings.cpp.
.SS "void KEMailSettings::setSetting (\fBKEMailSettings::Setting\fP s, const \fBQString\fP & v)"
.PP
Set one of the predefined 'basic' settings. 
.PP
\fBParameters:\fP
.RS 4
\fIs\fP the setting to set 
.br
\fIv\fP the new value of the setting, or QString::null to unset 
.RE
.PP

.PP
Definition at line 128 of file kemailsettings.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
