Skip to content
CA API Gateway - 9.3
Documentation powered by DocOps

Send Email Alert Assertion

Last update July 27, 2018

If you are running version 9.3 CR3 or later, refer to Send Email Assertion (9.3CR3) instead.  

The Send Email Alert assertion allows you to instruct the Gateway to deliver a pre-configured email message whenever the assertion is encountered in a policy.

The placement of the assertion in the policy path determines when and why an email is sent. For example, the assertion could be placed in an "At least one assertion must evaluate to true" assertion folder after an Evaluate Response XPath assertion. If the required response message element is not found and the Evaluate Response XPath assertion fails, then the Send Email Alert assertion will execute.

Tip: The Send Email Alert assertion fails if the outgoing email account is configured improperly. To configure the policy so that a failure of the Send Email Alert assertion does not cause a total policy failure, place the assertion in an At Least One Assertion Must Evaluate to True Assertion with a Continue Processing Assertion.

If you are encountering email timeouts while using this assertion, try adjusting the mail.outConnectTimeout and mail.outTimeout cluster properties.

Using the Assertion

  1. Do one of the following:
    • To add the assertion to the Policy Development window, see Add an Assertion.
    • To change the configuration of an existing assertion, proceed to step 2 below.
  2. When adding the assertion, the Email Alert Properties automatically appear; when modifying the assertion, right-click Send Email Alert in the policy window and select Email Alert Properties or double-click the assertion in the policy window. The assertion properties are displayed. 
  3. Configure the properties as follows:

    Tip: Context variables may be used in the following fields for greater flexibility: HostPortUsernamePasswordFromToCCBCCSubject.

    Setting Description
    Host The name of the outgoing mail server displayed as the default. Modify if necessary. You may reference context variables.
    Protocol

    Select the email protocol to use: Plain SMTP (default), SMTP over SSL, or SMTP with STARTTLS. The default setting should be appropriate in most instances. Consult your system administrator if you are unsure of the protocol.

    Notes:

    • You may need to configure trust for the SMTP server if using the "SMTP over SSL" or "SMTP with STARTTLS" protocols. For more information, see Managing Certificates.
    • If any error occurs when using SMTP with STARTTLS protocol, you can enable communication using default SSL implementation by adding a property com.l7tech.server.policy.emailalert.useDefaultSsl=True in system.properties file. This file is at /opt/SecureSpan/Gateway/node/default/etc/conf/ folder
      Ensure that you restart Gateway after setting the property value to True.

    Port The port used by the default mail server is displayed. Modify if necessary. You may reference context variables.
    Server Requires Authentication Select this check box if a name and password is required to log onto the email server.
    Username
    Password
    If authentication is required, enter the user name and password. You may reference context variables.
    Context variable in password Select this check box to allow the assertion to correctly recognize context variables used in the Password field; for example, you will be using the ${secpass.*} context variables. For more information, see Stored Password Properties.
    From Optionally enter a response email address. You may reference context variables.
    To Enter the email addresses of the recipients who will receive the alert. Separate multiple addresses with a comma. You may reference context variables.
    CC Optionally enter email addresses for CC (carbon copy) recipients. Separate multiple addresses with a comma. You may reference context variables.
    BCC Optionally enter email addresses for BCC (blind carbon copy) recipients. Separate multiple addresses with a comma. Recipients in the 'To' and 'CC' lists will not see the recipients in the 'BCC' list. You may reference context variables.
    Subject Enter a subject line describing the alert email. You may reference context variables.
    Message Body Enter the body of the alert email. You may include context variables within the message, if necessary.
    Send Test Email

    Sends a test email to the recipients. Use this to verify that the settings are correct.

    The [Send Test Email] button will not work if context variables have been used in the Email Alert Properties.

  4.  Click [OK].

Was this helpful?

Please log in to post comments.