EmailSettings

Email related settings for a system


Properties

string
alertEmailTo Optional

A comma separated email addresses to send all alert messages to


boolean
alertEmailToAllAdmins Optional

A flag to indicate the choice between sending alert emails to all system administrators in the system and designated list of email recipients


string
defaultEmailSubjectPrefix Optional

The prefix used in the email subject line for all email notifications and alerts from the system


boolean
defaultOrgEmail Optional

Flag indicating if the email settings are system default (true) or for a particular organization (false)


boolean
defaultSmtpServer Optional

Flag indicating if the smtp server settings are system default (true) or a particular organization (false)


string
senderEmailAddress Optional

Sender email address in an email notification or alert


smtpServer Optional

Represent the settings of an SMTP Server which the system uses to send email notifications and alerts

JSON Example

{
	"alertEmailTo": "string",
	"alertEmailToAllAdmins": false,
	"defaultEmailSubjectPrefix": "string",
	"defaultOrgEmail": false,
	"defaultSmtpServer": false,
	"senderEmailAddress": "string",
	"smtpServer": {
		"description": "string",
		"name": "string",
		"password": "string",
		"secureMode": "NONE",
		"sslTrustStore": "string",
		"url": {
			"host": "string",
			"port": 0,
			"ssl": false
		},
		"useAuthentication": false,
		"userName": "string"
	}
}
Property Of

TestEmailRequest

Feedback

Was this page helpful?