VMime
serviceInfos::property Class Reference
Collaboration diagram for serviceInfos::property:

Public Types

enum  Types { TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DEFAULT = TYPE_STRING }
 
enum  Flags { FLAG_NONE = 0, FLAG_REQUIRED = (1 << 0), FLAG_HIDDEN = (1 << 1), FLAG_DEFAULT = FLAG_NONE }
 

Public Member Functions

 property (const string &name, const Types type, const string &defaultValue="", const int flags=FLAG_DEFAULT)
 
 property (const property &p, const int addFlags=FLAG_NONE, const int removeFlags=FLAG_NONE)
 
 property (const property &p, const string &newDefaultValue, const int addFlags=FLAG_NONE, const int removeFlags=FLAG_NONE)
 
propertyoperator= (const property &p)
 
const stringgetName () const
 
const stringgetDefaultValue () const
 
Types getType () const
 
int getFlags () const
 

Static Public Attributes

static const property SERVER_ADDRESS
 
static const property SERVER_PORT
 
static const property SERVER_ROOTPATH
 
static const property AUTH_USERNAME
 
static const property AUTH_PASSWORD
 
static const property AUTH_ACCESS_TOKEN
 
static const property CONNECTION_TLS
 
static const property CONNECTION_TLS_REQUIRED
 

Detailed Description

A service property.

Member Enumeration Documentation

◆ Flags

enum Flags

Property flags.

Enumerator
FLAG_NONE 
FLAG_REQUIRED 
FLAG_HIDDEN 
FLAG_DEFAULT 

◆ Types

enum Types

Value types.

Enumerator
TYPE_INTEGER 
TYPE_STRING 
TYPE_BOOLEAN 
TYPE_DEFAULT 

Constructor & Destructor Documentation

◆ property() [1/3]

property ( const string name,
const Types  type,
const string defaultValue = "",
const int  flags = FLAG_DEFAULT 
)

Construct a new property.

Parameters
nameproperty name
typevalue type
defaultValuedefault value
flagsproperty attributes

◆ property() [2/3]

property ( const property p,
const int  addFlags = FLAG_NONE,
const int  removeFlags = FLAG_NONE 
)

Construct a new property from an existing property.

Parameters
psource property
addFlagsflags to add
removeFlagsflags to remove

◆ property() [3/3]

property ( const property p,
const string newDefaultValue,
const int  addFlags = FLAG_NONE,
const int  removeFlags = FLAG_NONE 
)

Construct a new property from an existing property.

Parameters
psource property
newDefaultValuenew default value
addFlagsflags to add
removeFlagsflags to remove

Member Function Documentation

◆ getDefaultValue()

const string & getDefaultValue ( ) const

Return the default value of the property or an empty string if there is no default value.

Returns
default value for the property

Referenced by serviceInfos::getPropertyValue().

◆ getFlags()

int getFlags ( ) const

Return the attributes of the property (see serviceInfos::property::Types constants).

Returns
property attributes

Referenced by serviceInfos::getPropertyValue().

◆ getName()

◆ getType()

serviceInfos::property::Types getType ( ) const

Return the value type of the property.

Returns
property value type

◆ operator=()

serviceInfos::property & operator= ( const property p)

Member Data Documentation

◆ AUTH_ACCESS_TOKEN

const serviceInfos::property AUTH_ACCESS_TOKEN
static

The common property 'auth.accesstoken' which is the access token used to authenticate with the server.

Referenced by defaultAuthenticator::getAccessToken().

◆ AUTH_PASSWORD

const serviceInfos::property AUTH_PASSWORD
static

The common property 'auth.password' which is the password used to authenticate with the server.

Referenced by defaultAuthenticator::getPassword().

◆ AUTH_USERNAME

const serviceInfos::property AUTH_USERNAME
static

The common property 'auth.username' which is the username used to authenticate with the server.

Referenced by defaultAuthenticator::getUsername().

◆ CONNECTION_TLS

const serviceInfos::property CONNECTION_TLS
static

The common property 'connection.tls': this is used to start a secured connection if it is supported by the server (STARTTLS extension).

◆ CONNECTION_TLS_REQUIRED

const serviceInfos::property CONNECTION_TLS_REQUIRED
static

The common property 'connection.tls.required' should be set to 'true' to make the connection process fail if the server can't start a secured connection (no effect if 'connection.tls' is not set to 'true').

◆ SERVER_ADDRESS

const serviceInfos::property SERVER_ADDRESS
static

The common property 'server.address' which is the host name or the IP address of the server.

◆ SERVER_PORT

const serviceInfos::property SERVER_PORT
static

The common property 'server.port' which is the port used to connect to the server.

◆ SERVER_ROOTPATH

const serviceInfos::property SERVER_ROOTPATH
static

The common property 'server.rootpath' which is the full path of the folder on the server (for maildir, this is the local filesystem directory).


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