Working with Email Alert Gateways

You can use an email alert gateway to specify the addressee(s) and the content of an email message.

Creating an Email Alert Gateway

To create an email alert gateway, follow this procedure.

  1. Navigate to Alerting > E-Mail Alert Gateways.
  2. Click .
  3. Choose a Partition and enter a Name.
  4. In the Address Pattern field, enter either a full email address, a partial email address with glob matching, or an alias (alias:<alias-name>). For more information, see Address Patterns.
  5. Enter or choose values in the fields Processing Order, Alert Resend Delay (in minutes), Alert Rate Limit, and Alert Rate Interval (in minutes). For more information on these fields, see Tabs and Fields.
  6. Optionally use the Headers tab to add Name=Value pairs to the header. For more information, see Headers. For information on using this tab to add recipients to an email, see Email Addresses and Aliases.
  7. To add an attachment to the email, click the File Attachment tab, click Add, and then enter a Name for the file attachment.
  8. To supply a RedwoodScript script to run before the email is sent, click the Actions tab.
  9. To specify the body of an email in HTML format, click the Email tab. You can use substitution parameters in this tab. For more information, see Customizing Alert Emails.
  10. Click Save & Close.

Deleting Email Alert Gateways

You can delete an email alert gateway only if no other objects relates to it. For example, if there are alert escalations that use an email alert gateway, the gateway cannot be deleted until all alert escalations that use it have been modified. You can see all alert escalations that relate to a gateway under Related Objects in the Detail View.

Tabs and Fields

Note: For tabs and fields that are common to all objects, see Object Tabs.

Tab Field Description
Email Alert Gateway Address Pattern The email address pattern that this email alert gateway should use. For more information, see Address Patterns.
Email Alert Gateway Processing Order The order in which this email alert gateway is processed. For more information, see Processing Order.
Email Alert Gateway Alert Resend Delay (in minutes) The delay in minutes before trying to resend a failed alert.
Email Alert Gateway Alert Rate Limit The number of alerts that can be sent to an address within the alert rate window.
Email Alert Gateway Alert Rate Interval (in minutes) The time interval in minutes for calculating the alert rate.
Headers Name The name of the an email header field. For more information, see Headers.
Headers Value The value of an email header field.
File Attachments Name You can attach any file associated with a failed process (such as stderr.log) to an email by entering its name here. This allows the operator to troubleshoot the problem without the need to connect to the system.
Actions Type The type of action. For email alert gateways, the only option is Pre Send.
Actions Enabled Lets you enable or disable the action.
Actions Library You can specify a library here containing methods you would like to use.
Actions Action Subject The user under which the code in the action is performed. You must set an action subject if you want to use jcsSession.
Actions Source The script to run.
Email Body The body of the email to send. For more information, see Customizing Alert Emails.

Note: For generally applicable object context menu options, see Object Context Menu.

Action Description
New e-mail alert gateway Creates a new email alert gateway.

Security

The privileges available in the Security tab are as follows.

For more information, see Security Tab.

Privilege Description
EmailAlertGateway.Create Create email alert gateways
EmailAlertGateway.Delete Delete email alert gateways
EmailAlertGateway.Edit Edit email alert gateways
EmailAlertGateway.View Access email alert gateways