Configuring and Troubleshooting Email (SMTP) Settings in ekp.properties

Applicable Product:

PeopleFluent Learning

 

Applicable Release:

All Versions

 

Overview

The LMS uses SMTP settings defined in ekp.properties to send system emails such as notifications, reminders, password resets, and reports. This article explains how SMTP configuration works, the meaning of key properties, and how to validate and troubleshoot common email-related issues.

 

Key SMTP Properties in ekp.properties

Email configuration is controlled by the following properties:

#system.smtpHost=smtp.example.com
#system.smtpPort=
#system.smtp.isSSL=
#system.smtp.security.explicitMode=
#system.forceexternalmail=Y

Only uncomment and configure these settings if external email delivery is required.

 

Understanding SMTP Security Modes

The LMS supports multiple SMTP connection modes. Choosing the correct combination is critical.

1. Non-SSL (Plain SMTP)

system.smtp.isSSL=false
system.smtp.security.explicitMode=false
system.smtpPort=25
  • Uses an unencrypted connection

  • Common in internal or legacy mail servers

  • Not recommended for public-facing environments


2. SSL / TLS (Implicit)

system.smtp.isSSL=true
system.smtpPort=465
  • Establishes SSL/TLS immediately

  • Common for older SMTP services

  • explicitMode should remain unset or false

 

3. STARTTLS (Explicit TLS)

system.smtp.isSSL=false
system.smtp.security.explicitMode=true
system.smtpPort=587
  • Connection starts unencrypted, then upgrades to TLS

  • Most commonly used by modern SMTP providers

  • Recommended when supported

 

Forcing External Email Delivery

system.forceexternalmail=Y

When enabled:

  • All emails are routed through the external SMTP server

  • User-configured email addresses are used

  • Internal mail delivery is bypassed

This setting should only be enabled when:

  • system.smtpHost is configured

  • External mail delivery is required for all notifications

 

Password Handling for SMTP Credentials

If SMTP authentication is configured (not shown in the sample but applicable in many setups):

  • Plain text passwords may be used temporarily

  • Encrypted passwords are license-dependent

  • After a license change, SMTP encrypted passwords must be regenerated

Follow the same encryption procedure used for database credentials:
Manage Center → System → Encrypt Password

 

Validation Steps

After updating SMTP settings:

  1. Restart the LMS service

  2. Trigger a test email (e.g., password reset)

  3. Review application logs for SMTP-related errors

  4. Confirm email delivery and formatting

 

Common Issues and Resolutions

Issue: Emails Are Not Being Sent

  • Verify system.smtpHost is reachable

  • Confirm correct port and security mode

  • Ensure LMS was restarted after changes

Issue: Authentication Errors

  • Verify username/password (if applicable)

  • Re-encrypt SMTP passwords after license changes

  • Check for extra spaces or hidden characters

Issue: Emails Sent Internally Only

  • Confirm system.forceexternalmail=Y is enabled

  • Ensure SMTP host is configured

 

Security Best Practices

  • Avoid leaving SMTP passwords in plain text

  • Restrict access to ekp.properties

  • Use encrypted passwords in production

  • Align SMTP settings with corporate security policies

 

Summary

  • SMTP configuration controls all outbound LMS emails

  • Correct security mode selection is critical

  • Encrypted SMTP passwords are license-dependent

  • Proper validation prevents missed notifications and user impact

Was this article helpful?

0 out of 0 found this helpful