Config2_EmailNotificationManager

Email notification management interface for the Version 2 API.

Instances of this class are obtained from:

Config2.emailNotifications

Properties

Property	Type	Description
smtp	Config2_SMTPSettings	SMTP server settings .

Methods

Method	Returns	Description
add()	Config2_EmailNotification	Add a new email notification .
get()	Config2_EmailNotification	Get an email notification by name .
remove()	void	Remove an email notification by name .
toArray()	Array.<Config2_EmailNotification>	Get all email notifications .

Property Details

smtp :Config2_SMTPSettings

Description:

SMTP server settings

SMTP server settings

Type:

Config2_SMTPSettings

Method Details

add(name, events, to, from, subject, message) → {Config2_EmailNotification}

Description:

Add a new email notification

Parameters:

Name	Type	Description
`name`	String	Notification name
`events`	String	Comma-separated list of event types to trigger on
`to`	String	Recipient email address
`from`	String	Sender email address
`subject`	String	Email subject
`message`	String	Email message body

Returns:

Created notification object

Type: Config2_EmailNotification

get(name) → {Config2_EmailNotification|null}

Description:

Get an email notification by name

Parameters:

Name	Type	Description
`name`	String	Notification name

Returns:

Notification object or null if not found

Type: Config2_EmailNotification | null

remove(name)

Description:

Remove an email notification by name

Parameters:

Name	Type	Description
`name`	String	Notification name

toArray() → {Array.<Config2_EmailNotification>}

Description:

Get all email notifications

Returns:

Array of all notification objects

Type: Array.<Config2_EmailNotification>