LogoLogo
TPI.devCommunityGithub
  • Overview
    • Introduction
      • Future Features
    • License & Disclaimer
    • APIM Architecture
      • Production Deployments and Capacity
      • Functions
      • Integration
    • Key Concepts
      • API Group
      • API Scope
      • API Client
      • End-to-End Workflow Combining API Group, API Scope, and API Client
        • Scenario: API Management for an E-commerce Platform
    • Support
    • Glossary
    • Scenarios
      • Financial Industry
        • Transforming Financial Services with digiRunner API Management
        • Redefining Financial Data Migration with digiRunner API Management Platform
      • Manufacturing Industry
        • Enabling Smart Manufacturing with Seamless API Integration and Automation via digiRunner
        • Streamlining Global Operations with API Management via digiRunner
      • Medical Industry
        • Enhancing Healthcare Data Integration and Security with digiRunner API Management
        • Revolutionizing Healthcare Interoperability with digiRunner’s Advanced API Framework
      • Insurance Industry
        • Modernizing Insurance Services with digiRunner API Management
        • Modernizing Insurance with digiRunner—Bridging Legacy Systems and Microservices
      • Government and Public Services
        • Empowering Open Government Services with digiRunner: A Mission for Integration and Transformation
        • Streamlining Public Sector Innovation via digiRunner: Driving Citizen-Centric Digital Transformation
  • Get Started
    • Installing digiRunner API Management
      • SMTP Configuration
    • Registering Your First APIs with digiRunner
    • Client Authorization and Calling APIs
    • Rate Limiting
    • Proxy Caching
    • Load Balancing
    • Sandbox Testing
    • VIP Gateway Priority Settings
    • JWE Certificate
  • Configuring IP Whitelisting via IP Binding
  • Most common use cases
    • Obtaining API Keys and Calling APIs
    • API IP Diversion
    • Viewing Real-time API Logs
    • Enabling APIs and No Auth in Batches with API Imported
    • Role-Based Access Management within a Hierarchical Structure
    • Simplified OIDC Login with Predefined Organizational Frameworks
    • Resetting User Password and Confirmation Email for Admin Console User
  • Guide
    • AC User Management
      • Users
      • My Profile
      • Roles
      • Role Mapping
      • Organization
      • Role & txID
      • Delegate AC User
      • AC OAuth 2.0 IdP
      • AC LDAP IdP
      • AC MLDAP IdP
      • AC API IdP
    • Development Mode
      • Function Management
      • Rtn Code Management
      • Embedded Function Management
    • Client Management
      • API Client
      • API Group
      • API Scope
      • Authentications
      • Security Level
      • GTW OAuth 2.0 IdP
      • GTW LDAP IdP
      • GTW API IdP
      • GTW JDBC IdP
      • Client Export/Import
    • API Management
      • API List
      • API Registry
      • API Test
      • API Modify Batch
    • Monitor & Alert
      • digiRunner Server
      • Alert Settings
    • Reports
      • API Calls
      • API RESP distribution
      • API Avg. RESP Time
      • API GTW traffic
      • Bad Attempt Report
    • Certificate Management
      • JWE Cert. List
      • JWE Cert. Management
      • TLS Cert. List
      • TLS Cert. Management
    • Application Forms
      • API Key
      • Applications
      • Approval Flow Settings
    • System Information
      • API Key Approval History
      • Scheduled Tasks
      • Recurring Tasks
      • Mail Log
    • System Configs
      • Setting
      • Items
      • Files
      • Customer Setting
      • Online Console
      • WebSocket Proxy Management
      • Static Webpage Reverse Proxy
      • RDB Connection
      • Mail Template Export/Import
  • API Integration Guide
    • Using Token for Authentication and Authorization
      • OpenID Connect (OIDC) Mode
      • Client Credentials Mode
      • Password Mode
    • Using X API Key for Authentication and Authorization
      • Applying for X API Key
      • Obtaining X API Key
      • Calling APIs Registered in digiRunner with X API Key
    • Using API Key for Authentication and Authorization
      • Applying for API Key
      • Obtaining API Key and Secret Key
      • Calculating the Signature and DGRK
      • Calling APIs Registered in digiRunner with API Key
    • Using HTTP Basic and OAuth for Authentication and Authorization
      • Calling APIs Registered in digiRunner with Basic Auth
      • Calling APIs Registered in digiRunner with No OAuth
    • Token Lifecycle Management Mechanism
      • Applying Refresh Token
      • Token Revocation
      • Token Introspection
    • JWS/JWE Integration
      • JWS Workflow
      • JWE Workflow
      • Exchanging Public Keys
      • Generating Certificate
      • Operating with JWS
      • Operating with JWE
Powered by GitBook
On this page
  • Access System Settings
  • Search for SMTP Settings
  • Configure SMTP Parameters
  • Validate Your Configuration
  • Trigger Email-sending Events
  • Resend Failed Emails

Was this helpful?

Export as PDF
  1. Get Started
  2. Installing digiRunner API Management

SMTP Configuration

PreviousInstalling digiRunner API ManagementNextRegistering Your First APIs with digiRunner

Last updated 2 months ago

Was this helpful?

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. 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.

      • 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.

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.

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

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

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