Sisense uses Mandrill by MailChimp to send automated emails such as dashboard reports or password reset emails. Custom email servers allow all our email transactions to be completely managed on your side.

Through the Sisense REST API, you can send an HTTP POST request to issue Sisense emails through your own custom email server instead of the default Sisense email server. The REST API exposes properties that you can configure for the custom email servers such as security, timeout, and logging properties.

To set up a custom email server:

  1. In the Sisense Web Application, click ADMIN at the top right, and then REST API, followed by REST API Reference.
  2. In the top-right corner of the page, select version 1.0 of the REST API.
  3. Select Settings, then POST /settings/email_server.
  4. In the body of your call, define the values of the following keys:
    KeyValue
    enableIf True, allows access to the custom email server instead of the default Sisense email server.

    Note: This property is different from the enable property found in version .9 of the REST API POST /settings/system request. In .9, enable activates Sisense emails. In version 1.0, enable sends Sisense emails through your custom server.
    hostThe hostname or IP address to connect to. By default, this is 'localhost'.
    portThe port to connect to (defaults to 25 or 465).
    secureWhen you send an email, some email servers check if secure transport (TLS) is available for that address or domain.
    This value determines if the connection should use TLS (if True) or not (if False). The default value is false.
    The connection may be upgraded to TLS if the email server requires it.
    ignoreTLSIf this is True and secure is False, TLS will not be used even if the email server attempts to upgrade the connection to TLS-secure.

    This field should be set to True when connecting to a non-secure SMTP server.
    requireTLSIf this is True and secure is False, it forces the connection to be upgraded to TLS-secure even if the email server does not advertise support for TLS.
    connectionTimeoutHow many milliseconds to wait for the connection to establish.
    greetingTimeoutHow many milliseconds to wait for the greeting after connection is established.
    socketTimeoutHow many milliseconds of inactivity to allow.
    userThe user name of the user.

    As non-secure or restricted SMTP servers do not require authentication, do not include this field when connecting to a non-secure SMTP server.
    passThe user’s password for the email server.

    As non-secure or restricted SMTP servers do not require authentication, do not include this field when connecting to a non-secure SMTP server.
    loggerIf set to True, Sisense logs events such as which server you connected to.
    If the value is not defined or is False, then nothing is logged.
    debugIf set to True, then Sisense logs SMTP traffic. When False, Sisense logs only transaction events.

    Debug logs record everything and may increase in size quickly and impact performance. You should only set activate debug logging when troubleshooting a specific issue and then reset the logging level back to info.
  5. Click Run.

Limitations

  • When authenticating an HTTP request, Sisense only supports the basic authentication through the Authorization method using plain text.
  • No Errors are displayed in the UI.

Troubleshooting a Custom Email Server

Sisense does not provide a UI for troubleshooting an issues with your custom email server. To troubleshoot any issue with your custom email server, activate logging through the logger and debug keys in the REST API. When logger and debug are set to True, Sisense generates logs that are saved in the following directory:

c:\Program Files\Sisense\PrismWeb\vnext\iisnode

After troubleshooting the issue, the debug logger should be disabled as the logs can grow in size rapidly and this may impact performance.