Config Class Reference

Configuration information for the Task Manager This table contains Parameter/Value pairs for the Configuration information

Users may access the Email parameters/values using the EmailSet() or EmailGet() methods. More...

Inheritance diagram for Config:

Collaboration diagram for Config:

Static Public Member Functions
_.Library.Status	EmailGet (_.Library.String Parameter, _.Library.String Value)
	Retrieve the email settings for the Task Manager. More...
_.Library.Status	EmailSet (_.Library.String Parameter, _.Library.String Value)
	Set the email parameters for the Task Manager. More...
_.Library.String	SubstitutionFields ()
	Available fields for substitution into mail message subject / body.
_.Library.Boolean	SubstitutionsValid (text, bad)
	Validate substitution fields in a message. More...
_.Library.String	genericMailMessage ()
	Return the generic Task Manager email message text.
_.Library.String	genericMailSubject ()
	Return the generic Task Manager email subject text.

Public Attributes
	Data
	Parameter Value. More...
	ParamName
	Parameter Name. More...

Detailed Description

Configuration information for the Task Manager This table contains Parameter/Value pairs for the Configuration information

Users may access the Email parameters/values using the EmailSet() or EmailGet() methods.

Member Function Documentation

EmailGet()

_.Library.Status EmailGet ( _.Library.String  Parameter, _.Library.String  Value  )

static

Retrieve the email settings for the Task Manager.

Available Parameters are:

"Server","Port","ReplyTo","Sender","TimeZone","AuthUser","AuthPassword", "SubjectSuccess","SubjectFailure","MessageSuccess","MessageFailure","SSLConfiguration","UseSTARTTLS"

EmailSet()

_.Library.Status EmailSet ( _.Library.String  Parameter, _.Library.String  Value  )

static

Set the email parameters for the Task Manager.

Available Parameters are:

"Server","Port","ReplyTo","Sender","TimeZone","AuthUser","AuthPassword", "SubjectSuccess","SubjectFailure","MessageSuccess","MessageFailure","SSLConfiguration","UseSTARTTLS"

SubstitutionsValid()

_.Library.Boolean SubstitutionsValid (   text,   bad  )

static

Validate substitution fields in a message.

'bad' returns a specific problem field.

Member Data Documentation

Data

Data

Parameter Value.

 

ParamName

ParamName

Parameter Name.