Module: settings/js/widgets/mail-widget

Classes

MailWidget

Type Definitions

MailConfiguration

Properties:

Name	Type	Argument	Description
connectionSecurity	string		The security method to use. Can be either NONE, TLS, or STARTTLS
enabled	boolean		True if the widget is enabled; false otherwise
from	string		The email address to be used as the sender
host	string		The host of the email server
password	string	<optional>	The password to use when authenticating with the mail server. If passwordRedacted is true then this should be empty
passwordRedacted	boolean	<optional>	True if the password exists but is not visible; false otherwise
port	number		The port of the email server
to	string		Comma separated list of email addresses to be used as the recipient
username	string	<optional>	The username to use when authenticating with the mail server

Source:

• widgets/mail-widget.js, line 103

MailWidgetOptions

Extends ServerWidgetOptions

Properties:

Name	Type	Description
securityTypes	object.<string, string>	Security options to use. Keys should be NONE, STARTTLS and TLS. Values should be display names.
strings	MailWidgetStrings	Strings for the widget

Source:

• widgets/mail-widget.js, line 40

MailWidgetStrings

Extends WidgetStrings, EnableViewStrings and PasswordViewStrings

Properties:

Name	Type	Description
hostPlaceholder	string	Placeholder for the mail server host input
portPlaceholder	string	Placeholder for the mail server port input
validateHostBlank	string	Message displayed when the mail server host is empty
connectionSecurity	string	Label for the security method dropdown
fromLabel	string	Label for the sender input
validateFromBlank	string	Message displayed when the sender input is empty
toLabel	string	Label for the recipient input
toDescription	string	Instructions for the recipient input
validateFromBlank	string	Message displayed when the recipient input is empty
mailCheckbox	string	Label for checkbox which enables authentication
usernameLabel	string	Label for the username input
validateUsernameBlank	string	Message displayed when the username input is empty

Source:

• widgets/mail-widget.js, line 24