Class: MailWidget

Extends

• module:settings/js/server-widget.ServerWidget

Members

className :string

Classes applied to the widget. Override if using Bootstrap 3

Type:

• string

Inherited From:

• module:settings/js/server-widget.ServerWidget#className

Default Value:

• Widget.prototype.className + ' settings-servergroup control-group form-horizontal'

Source:

• server-widget.js, line 39

controlGroupClass

Class applied to control groups. Set to 'form-group' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#controlGroupClass

Default Value:

• control-group

Source:

• widget.js, line 54

errorClass

Class used to indicate failed validation. Set to 'has-error' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#errorClass

Default Value:

• error

Source:

• widget.js, line 72

formControlClass

Class applied to form controls. Set to 'form-control' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#formControlClass

Default Value:

• ''

Source:

• widget.js, line 60

serverTemplate :module:settings/js/server-widget.ServerWidget~ServerWidgetTemplate

Base template for the widget. Override if using Bootstrap 3

Type:

• module:settings/js/server-widget.ServerWidget~ServerWidgetTemplate

Inherited From:

• module:settings/js/server-widget.ServerWidget#serverTemplate

Source:

• server-widget.js, line 53

successClass

Class used to indicate successful validation. Set to 'has-success' if using Bootstrap 3

Inherited From:

• module:settings/js/widget.Widget#successClass

Default Value:

• success

Source:

• widget.js, line 66

widgetTemplate :module:settings/js/widget.Widget~WidgetTemplate

Base template for the widget. Override if using Bootstrap 3

Type:

• module:settings/js/widget.Widget~WidgetTemplate

Inherited From:

• module:settings/js/widget.Widget#widgetTemplate

Source:

• widget.js, line 90

Methods

<protected> displayValidationMessage(isEqual, response)

If isEqual is true displays a message showing the result of a validation. Otherwise clears the
validation state

Parameters:

Name	Type	Description
isEqual	boolean	True if the config is equal to the config received from the server; false otherwise
response	ValidationResponse	The repsonse from the server

Inherited From:

• module:settings/js/server-widget.ServerWidget#displayValidationMessage

Source:

• server-widget.js, line 100

getConfig() → {MailConfiguration}

Returns the configuration represented by the widget

Source:

• widgets/mail-widget.js, line 120

Returns:

The configuration represented by the widget

Type

MailConfiguration

getName() → {string}

Gets the name for the widget

Inherited From:

• module:settings/js/widget.Widget#getName

Deprecated:

• Users of this class do not need to call this

Source:

• widget.js, line 131

Returns:

this.serverName, or this.configItem if serverName is undefined

Type

string

getValidationFailureMessage(response) → {string}

Generates a message indicating that validation was unsuccessful

Parameters:

Name	Type	Description
response	ValidationResponse	The response from the server

Inherited From:

• module:settings/js/server-widget.ServerWidget#getValidationFailureMessage

Source:

• server-widget.js, line 135

Returns:

A message indicating validation was unsuccessful

Type

string

getValidationSuccessMessage(response) → {string}

Generates a message indicating that validation was successful

Parameters:

Name	Type	Description
response	ValidationResponse	The response from the server

Inherited From:

• module:settings/js/server-widget.ServerWidget#getValidationSuccessMessage

Source:

• server-widget.js, line 126

Returns:

A message indicating validation was successful

Type

string

handleInputChange()

Handler for change events on any inputs in the widget. Calls hideValidationInfo and
setValidationFormatting

Inherited From:

• module:settings/js/widget.Widget#handleInputChange

Source:

• widget.js, line 139

handleSecurityChange()

Handler called when the security method is changed. Updates the port to the default for that type

Source:

• widgets/mail-widget.js, line 157

handleValidation()

Handles the results of server side validation

Inherited From:

• module:settings/js/server-widget.ServerWidget#handleValidation

Source:

• server-widget.js, line 84

hideValidationInfo()

Removes validation information as defined in Widget and also hides the connection state

Inherited From:

• module:settings/js/server-widget.ServerWidget#hideValidationInfo

Source:

• server-widget.js, line 142

render()

Renders the widget

Source:

• widgets/mail-widget.js, line 79

setValidationFormatting(state)

Removes this.successClass and this.errorClass from elements in the widget with this.controlGroupClass.

If state === 'clear', remove successClass and errorClass from this.$el. Otherwise adds the given class
and removes the other class

Parameters:

Name	Type	Description
state	string	clear to remove classes, otherwise this.successClass or this.errorClass to add that class and remove the other class

Inherited From:

• module:settings/js/widget.Widget#setValidationFormatting

Source:

• widget.js, line 174

shouldValidate() → {boolean}

Determines if the widget should be validated

Source:

• widgets/mail-widget.js, line 183

Returns:

True if the widget is enabled; false otherwise

Type

boolean

triggerValidation()

Triggers validation when the test connection button is pressed

Inherited From:

• module:settings/js/server-widget.ServerWidget#triggerValidation

Source:

• server-widget.js, line 159

Fires:

• event:validate Event indicating that validation should take place

<protected> updateAuthState(authRequired)

Enables the username and password inputs if authentication is required, and disables them if not

Parameters:

Name	Type	Description
authRequired		True if authentication should be used; false otherwise

Source:

• widgets/mail-widget.js, line 172

updateConfig(config)

Updates the widget with the given config

Parameters:

Name	Type	Description
config	MailConfiguration	The new configuration for the widget

Source:

• widgets/mail-widget.js, line 191

<protected> updateInputValidation($input, isValid)

Updates the formatting of the given input

If isValid is true, removes errorClass from the input and hides elements with the class
settings-client-validation

If isValid is false, adds errorClass to the input and shows elements with the class
settings-client-validation

Parameters:

Name	Type	Description
$input	jQuery	The input to apply the classes to
isValid	boolean	True if the input is valid; false otherwise

Inherited From:

• module:settings/js/widget.Widget#updateInputValidation

Source:

• widget.js, line 214

validateInputs() → {boolean}

Validates the widget and applies formatting as appropriate

Source:

• widgets/mail-widget.js, line 212

Returns:

False if the host is empty, the from field is empty, the recipient list is empty, or the
username or password fields are blank if authentication is used; true otherwise

Type

boolean