TPI.devCommunityGithub

SMTP Configuration

After installing digiRunner, configuring an SMTP server is essential to enable system-generated email notifications — such as account creation alerts, password reset messages, system warnings, API key application.

This section provides step-by-step instructions for setting up the SMTP mail sender within the digiRunner Admin Console.

Access System Settings

  1. Log in to your digiRunner Admin Console.

  2. Go to System Configs > Setting to access the configuration page.

Search for SMTP Settings

  1. In the Setting page, enter keywords mail or smtp in the search bar.

  2. Click the search icon to filter and display related configuration keys.

Configure SMTP Parameters

  1. Update the following key parameters based on your mail server configuration:

Parameter
Description

SERVICE_MAIL_ENABLE

Enables or disables email functionality. Must be set to true.

SERVICE_MAIL_AUTH

Enables SMTP authentication. Set to true if login credentials are required.

SERVICE_MAIL_STARTTLS_ENABLE

Enables TLS encryption. Strongly recommended.

SERVICE_MAIL_HOST

Your SMTP server address, e.g., smtp.gmail.com.

SERVICE_MAIL_PORT

SMTP server port, typically 587 for TLS.

SERVICE_MAIL_FROM

Sender email address shown in the From field.

SERVICE_MAIL_USERNAME

SMTP username for authentication.

SERVICE_MAIL_PASSWORD

SMTP password for authentication.

  1. Click on the (Update) icon next to each parameter to update its value, then click Update to apply the changes.

  2. Make sure both SERVICE_MAIL_ENABLE and SERVICE_MAIL_AUTH are set to true to enable proper email functionality.

  1. By default, digiRunner uses Gmail’s SMTP, smtp.gmail.com, and port 587 for TLS-encrypted delivery.

Validate Your Configuration

Trigger Email-sending Events

  1. To ensure that your SMTP configuration works properly, create a new user, reset a password, or trigger a system alert to trigger an email-sending event.

  2. Go to System Information > Mail Log to check the result:

    • If Result = success, the email was sent correctly.

    • If Result = failure, click on the (Details) icon to view the error.

      • Example error: A message displaying Username and Password not accepted indicates your SMTP credentials are incorrect.

Resend Failed Emails

  1. Go to System Information > Scheduled Tasks to proceed.

  2. Find the task, e.g., SEND_MAIL.

  3. Click on the (Redo) icon, and click Confirm to re-trigger the mail sending task.

NOTE:

  • Always enable TLS to ensure secure transmission.

  • Double-check SMTP credentials, hostnames, and port settings.

  • Ensure your firewall allows outbound connections to the SMTP server (typically on port 25, 465, or 587).

  • For Gmail users:

    • Enable App Passwords or Allow less secure apps if required.

    • Avoid using personal accounts in production environments.

PreviousInstalling digiRunner API ManagementNextRegistering Your First APIs with digiRunner

Last updated

Was this helpful?