Skip to Content

Configure SMTP in Jitterbit App Builder

Overview

To send emails from an App Builder app, you must first configure the SMTP settings.

Simple Mail Transfer Protocol (SMTP) is the standard protocol for sending emails across the internet. App Builder natively supports SMTP. Scenarios where App Builder sends emails include workflow notifications or those sent by the password reset feature. In order for any mail to be sent from App Builder, you must first configure SMTP settings.

SMTP configuration table

The SMTP server is registered as a Notification Endpoint. App Builder ships with a single SMTP notification endpoint which administrators must configure to enable SMTP operations.

Property Value
URI smtp://mail.example.com:PORT

Note

Although optional, a PORT is nearly always specified at the end of the URI. If it is not specified, the default is 25.
UserName A username.
Password A password.
Default From Address A valid email address that is allowed to send mail via the given host.

Configure SMTP in App Builder

To configure the URI and Default From Address values, follow these steps:

  1. Navigate to the IDE.

  2. From the Connect options, click the Notification Servers button.

  3. Click the Edit icon under Notification Endpoints for the SMTP record. Alternatively, you can also double click the row or click the icon, which opens a dialog where you can follow the next steps while also getting access to a testing feature.

  4. Enter the appropriate URI value. The format of this value is critical, and should either be smtp://<hostname> or smtps://<hostname>. See the list of supported protocols. If sending email from a server hosted in the AWS US-East-1 region, for instance, you will enter smtps://email-smtp.us-east-1.amazonaws.com.

  5. Enter the appropriate Default From Address value. It must be a valid address via the given host. If a notification rule doesn't specify a From address, the one entered in this field will be used.

  6. Click the Proceed button to save your changes.

smtp_config.png

Supported protocols

Protocol Definition
SMTP Simple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail transmission. Standard ports: 25, 587, 465
SMTPS Simple Mail Transfer Protocol Secure (SMTPS) is a depreciated method for securing SMTP connections with Transport Layer Security (TLS).

Important

App Builder does not support OAuth 2.0 for SMTP server authentication.

Troubleshooting

Error: "Argument passed in is not serializable. Parameter name: value"
This error may indicate App Builder is not able to authenticate the SMTP settings, and in particular the Default From Address value. Check the DefaultFromAddress property for the Notification Endpoint, and ensure it is using a valid email address for the given host.

Error: "Value cannot be null. ParameterName: From Address"
This error may indicate App Builder is not able to authenticate the SMTP settings, and in particular the Default From Address value. Check the DefaultFromAddress property for the Notification Endpoint, and ensure it is using a valid email address for the given host, and not null or empty.

Error: "Unknown URI scheme. Parameter name: uri"
This error may indicate App Builder is not able to authenticate the SMTP settings, and in particular the Uri value. Check the Uri property for the Notification Endpoint, and ensure it is using a valid Uri value.

Error: "Authentication required"
This error may indicate App Builder is not able to authenticate the SMTP settings, and in particular either the UserName or Password property related to the SMTP configuration. Check that the Notification Endpoint settings have the correct values set for both User Name and Password.