Was this page helpful?
Yes No

Configure SMTP Setup

Tableau Server on Windows now includes Tableau Services Manager (TSM), which replaces the Configuration Utility and the command line tool. If you need help for an earlier version of Tableau Server, see the Tableau Help page.

Tableau Server can email server administrators about system failures, and email server users about subscribed views and data-driven alerts. First, however, you need to configure the SMTP server that Tableau Server uses to send email. After configuring SMTP, complete the steps to configure notifications (Configure Server Event Notification), then when you start or restart the server, it will trigger an email notification, which confirms that you have set up notifications correctly.

Configuring SMTP requires that you restart Tableau Server services.

In this article

ClosedUse the TSM web interface Use the TSM web interface
  1. Open TSM in a browser:

    https://<tsm-computer-name>:8850. For more information, see Sign in to Tableau Services Manager Web UI.

  2. Click Notificationson the Configuration tab and click Email Server.

  3. Enter the SMTP configuration information for your organization:

  4. Click Save Pending Changes after you've entered your configuration information.

  5. Click Apply Changes and Restart.

ClosedUse the TSM CLI Use the TSM CLI

For the initial configuration of SMTP, we recommend that you use the configuration file template below to create a json file. You can also set any single configuration key listed below with the syntax described in tsm configuration set.

  1. Copy the following json template to a file. Fill in the key values with your SMTP configuration. See the reference section that follows for more information about SMTP key options.

    								{
    "configKeys": {
    	"svcmonitor.notification.smtp.server": "SMTP server url",
    	"svcmonitor.notification.smtp.send_account": "SMTP user name",
    	"svcmonitor.notification.smtp.port": 25,
    	"svcmonitor.notification.smtp.password": "SMTP server password",
    	"svcmonitor.notification.smtp.ssl_enabled": false,
    	"svcmonitor.notification.smtp.from_address": "From email address",
    	"svcmonitor.notification.smtp.target_addresses": "To email address1,address2",
    	"svcmonitor.notification.smtp.canonical_url": "Tableau Server URL"
    		}
    }
  2. Run the tsm settings import -f file.json to pass the json file with the appropriate values to Tableau Services Manager to configure Tableau Server for SMTP. Tableau Services Manager will validate the entity values.

  3. Run the tsm pending-changes apply command to apply the changes. See tsm pending-changes apply.

Configuration file reference

This table lists all of the options that can be used to configure SMTP.

Option Description
svcmonitor.notification.smtp.server Address of SMTP server.

Example:

"svcmonitor.notification.smtp.server": "mail.example.com"

svcmonitor.notification.smtp.send_account User name for SMTP account.
svcmonitor.notification.smtp.port Port number for SMTP server. The default is 25.
svcmonitor.notification.smtp.password Password for SMTP server account.

Example:

"svcmonitor.notification.smtp.password":"password"

svcmonitor.notification.smtp.ssl_enabled Specifies whether the connection to the SMTP server is encrypted. The default is false.

Note: This should be left as false. Encrypted SMTP connections are not supported for notifications or subscriptons.

svcmonitor.notification.smtp.from_address Email address that will send an notification if there's a system failure. The email address must have valid syntax (for example, ITalerts@bigco.com or noreply@mycompany), but it does not have to be an actual email account on Tableau Server. (Some SMTP servers may require an actual email account, however.)

Note: You can override the system-wide email address on a per-site basis. For more information, see What is a site.

Example:

"svcmonitor.notification.smtp.from_address": "donot-reply@example.com"

svcmonitor.notification.smtp.target_addresses Email address to receive notifications. If email notifications are enabled, you need to include at least one address. Separate multiple addresses with commas.

Example:

"svcmonitor.notification.smtp.target_addresses": "iluvdata@example.com"

svcmonitor.notification.smtp.canonical_url URL of the Tableau Server. Enter http:// or https://, followed by the name or IP address of the Tableau server. Used in the footer of subscription email.

Example:

"svcmonitor.notification.smtp.canonical_url": "http://myserver.example.com"