The  can be integrated with an existing SMTP server for delivering emails to users of the platform. This configuration is necessary if the following features are enabled:

• Users are required to validate their email addresses after self-registration. Both of these options must be enabled. See Configure User Self-Registration.
• Users are permitted to reset their passwords. See Enable Self-Service Password Reset.

Limitations

Configure SMTP

To enable, please complete the following.

Steps:

1. 

2. Edit the SMTP settings:

   "smtp.host": "<SMTP_HOST>", "smtp.port": "587" "smtp.username": "<EMAIL_ACCT_USERNAME>", "smtp.password": "<EMAIL_ACCT_PWD>", "smtp.enableSSL": true "smtp.validateRegistrationEmail": false, "smtp.rejectUnauthorized": true, "smtp.authenticated": true,

   Setting	Description
   host	Hostname of the SMTP server
   port	Port number to use to contact the SMTP server; the server listens for new email on this port. 587 is the default value. Tip: SMTP port 25 can be used as a listening port, too.
   username	Username of the email account to use to send emails to users. NOTE: This username appears in the email message.
   password	Password of the email account to use.
   enableSSL	Set to true, if the SMTP server is configured to use SSL. Default is true. . NOTE: When SSL is enabled for the email server, its certificate cannot be self-signed.
   validateRegistrationEmail	When set to true, an email is sent to confirm registration to newly registered users, based on the configured SMTP server connection.
   rejectUnauthorized	When set to true, the email server rejects any connection that is not authorized from the list of supported certificate authorities.
   authenticated	If you use an unauthenticated SMTP connection, set this value to false.

3. Save your changes and restart the platform.

Configure email sender

You can configure the email address and display name of all emails sent from the .

Steps:

1. 

2. Edit the following settings:

   "webapp.emailSender": "<SENDER_EMAIL_ADDRESS>", "webapp.emailSenderName": "<SENDER_DISPLAY_NAME>",

   Setting	Description
   emailSender	Enter an email account to use as the displayed sender of these emails. Tip: You should enter a value here to mask the real user account that is specified for the SMTP server connection.
   emailSenderName	Display name of the sender of emails.

3. Save your changes and restart the platform.

Test SMTP

 can send a test email to a specified email address using the configured SMTP settings. For more information, see Admin Settings Page.

Other email integration tests:

• If it's been enabled, you can reset user password. See Enable Self-Service Password Reset.
• If email registration validation has been enabled, you can create a new user account to verify that the SMTP server is working.
• If neither of the above is enabled, you can use an external testing method to verify that the SMTP server is working properly.

Enable Email Notifications

Optionally, you can enable the  to send email notifications on the status of job executions using the configured SMTP server.

Steps:

1. 

2. Configure the following three parameters:
   
   

   Parameter	Setting
   Email notifications	Set this parameter to enabled to permit the platform to send email notifications. Default is disabled.
   Email notifications: on Job Failure	Set this parameter to the default types of jobs that generate emails when they fail. Default is scheduled.
   Email notifications: on Job Success	Set this parameter to the default types of jobs that generate emails when they succeed. Default is never.

   Tip: The above defaults can be overridden for individual flows. See below.

   For more information on the available settings, see Workspace Settings Page.

3. To display correct images and links in the emails, please do the following:
   1. 

   2. Locate the following parameter. Verify that its value is set to the host and port number of the :
      
      

      "webapp.hostUrl": "http://example.com:3005"

   3.  Save your changes and restart the platform.

Configure Notifications

You can configure email notifications to be sent based on job executions from individual flows. Non-collaborating watchers can be informed, as well. These settings override the workspace defaults. See Manage Flow Notifications Dialog.