Email Notifications

Nexial supports email notification at the end of an execution through the use of System Variables. By default, sending email notifications is not enabled as using email to communicate execution status carries a variety of possible side issues. Nonetheless, email notification is supported in Nexial.

Execution Summary

The email notification at the end of an execution provides a basic summary of the execution process. This summary includes:

• The version of Nexial used.
• The host name and user name from which the execution was run.
• The number of scripts executed and the time span.
• Number of passed/failed steps and scenarios and the total success percentage.
• Summarized results of the script/plan execution.

Additionally, Nexial provides features like:

• Sending email notification to multiple recipients.
• Adding custom subject, footer and header to the notification.
• Sending pre-configured emails.
• Conditional notification.

Read more about pre-configured emails and conditional notifications on the Event Notification page.

Example of an Email Notification:

Configuring Data Variables

1. Use the system variable nexial.enableEmail and set it to true


2. Define the mail server connectivity details in the data file according to your email service.
   
   
   • SMTP Service
   • AWS - Simple Email Service

   Nexial uses the following variables to specify connection details:
   
   

   1. nexial.mail.smtp.host - the hostname or DNS name of your mail server.
   2. nexial.mail.smtp.port - 25 (or whatever the configured SMTP port).
   3. nexial.mail.smtp.from - sender's email address.
   4. nexial.mail.smtp.auth - true|false.
   5. nexial.mail.smtp.username - username only needed if nexial.mail.smtp.auth is set to true.
   6. nexial.mail.smtp.password - password only needed if nexial.mail.smtp.auth is set to true.

   
   
   Example:
   
   
   Note: nexial.mail.smtp.starttls.enable is required to be true. when Gmail is used as the email service.

   SES, or Simple Email Service, is a cloud service provided by Amazon AWS. One can utilize such service to send, receive and manage email activities in the cloud. Currently Nexial supports the use of SES for sending email to one or more recipients.

   
   Nexial uses the following variables to specify AWS connection details:
   
   

   1. nexial-mailer.aws.accessKey - The access key valid for the target AWS service.
   2. nexial-mailer.aws.from - the FROM email address.
   3. nexial-mailer.aws.region - The target region to connect to.
   4. nexial-mailer.aws.secretKey - The secret key valid for the target AWS service.

   
   
   Example:
   


3. Define the recipient email or comma separated list of recipients via the nexial.mailTo System variable.


4. [OPTIONAL] Use nexial.mailSubject, nexial.mailHeader and nexial.mailFooter system variables to add subject, header and footer to the email respectively.

Email Notification with header, footer and subject:

Follow this guide for onetime setup for email notification using nexial-setup

See Also

• commands » mail
• tipsandtricks » IntegratingNexialWithEmail