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:
NOTE: Installation and use of custom certificates on the |
To enable, please complete the following.
NOTE: If you are planning to enable SSL for communicating with the SMTP server, you must generate first a certificate for the server that is not self-signed. |
NOTE: For more information on the settings to use in your environment, please contact your email administrator. |
Steps:
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.
| |
username | Username of the email account to use to send emails to users.
| |
password | Password of the email account to use. | |
enableSSL
| Set to
| |
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 . |
You can configure the email address and display name of all emails sent from the .
Steps:
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.
| |
emailSenderName | Display name of the sender of emails. |
Save your changes and restart the platform.
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:
Optionally, you can enable the to send email notifications on the status of job executions using the configured SMTP server.
NOTE: This feature requires access to an SMTP server to send emails. |
Steps:
Configure the following three parameters:
Parameter | Setting |
---|---|
Email notifications | Set this parameter to |
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.
Locate the following parameter. Verify that its value is set to the host and port number of the :
"webapp.hostUrl": "http://example.com:3005" |
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.