You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/kio/kio/kemailsettings.h

148 lines
3.8 KiB

/*-
* Copyright (c) 2000 Alex Zepeda <zipzippy@sonic.net>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#ifndef _KEMAILSETTINGS_H
#define _KEMAILSETTINGS_H
#include <tqstring.h>
#include <tqstringlist.h>
#include <kdelibs_export.h>
class KEMailSettingsPrivate;
/**
* 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
**/
class KIO_EXPORT KEMailSettings {
public:
/**
* 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 getSetting()
* @see setSetting()
* @see getExtendedSetting()
* @see setExtendedSetting()
**/
enum Setting {
ClientProgram,
ClientTerminal,
RealName,
EmailAddress,
ReplyToAddress,
Organization,
OutServer,
OutServerLogin,
OutServerPass,
OutServerType,
OutServerCommand,
OutServerTLS,
InServer,
InServerLogin,
InServerPass,
InServerType,
InServerMBXType,
InServerTLS
};
/**
* The various extensions allowed.
**/
enum Extension {
POP3,
SMTP,
OTHER
};
/**
* Default constructor, just sets things up.
**/
KEMailSettings();
/**
* Default destructor, nothing to see here.
**/
~KEMailSettings();
/**
* List of profiles available.
* @return the list of profiles
**/
TQStringList profiles() const;
/**
* Returns the name of the current profile.
* @returns what profile we're currently using
**/
TQString currentProfileName() const;
/**
* Change the current profile.
* @param s the name of the new profile
**/
void setProfile (const TQString &s);
/**
* Returns the name of the default profile.
* @returns the name of the one that's currently default TQString::null if none
**/
TQString defaultProfileName() const;
/**
* Sets a new default.
* @param def the new default
**/
void setDefault(const TQString &def);
/**
* Get one of the predefined "basic" settings.
* @param s the setting to get
* @return the value of the setting, or TQString::null if not
* set
**/
TQString getSetting(KEMailSettings::Setting s);
/**
* Set one of the predefined "basic" settings.
* @param s the setting to set
* @param v the new value of the setting, or TQString::null to
* unset
**/
void setSetting(KEMailSettings::Setting s, const TQString &v);
private:
KEMailSettingsPrivate *p;
};
#endif