Knowledge Base Administration Guide

SMTP Email Configuration (Mail)

Simscope uses SMTP to send email notifications to Users.

SMTP Configuration

Simscope can be configured either using basic or authenticated SMTP access.

a. Basic SMTP Configuration (anonymous)

If your SMTP allows anonymous access to send emails (ie Unix emails), here is how to configure:

[email]
enabled = true
# Sender is what shows up as the email sender
sender = "Simscope Triage <no-reply-simscope@COMPANY.com>"
# Set this to the administrator email address, to receive Simscope admin emails
adminaddr = "fred@COMPANY.com"

# Unix SMTP config (change YOUR-SMTP-HOSTNAME)
smtpaddr = "YOUR-SMTP-HOSTNAME:25"

# Note: if you are allowed SMTP relaying via localhost:
# smtpaddr = "localhost:25"

b. Authenticated SMTP Configuration

If your SMTP requires user/password authentication to send emails, here is how to configure:

[email]
enabled = true
# Sender is what shows up as the email sender
sender = "Simscope Triage <no-reply-simscope@COMPANY.com>"
# Set this to the administrator email address, to receive Simscope admin emails
adminaddr = "fred@COMPANY.com"

# Authenticated SMTP
smtpaddr = "smtp.company.com:587"
# NOTE: other common SMTP ports are :25 and :465

smtpaccount = "myuser@company.com"
smtpauth = "mypass"

# optional: If the SMTP hostname is different than the address, you can override it
# smtphost = "smtp.company.com"

# Enable STARTTLS (recommended)
starttls = true
# Enable TLS (not recommended)
# tls = true

Testing SMTP emails

After configuring SMTP, you can issue an API token for a user, which will automatically send an email from Simscope:

User API Token


Check SMTP email

Simscope has an Outbox for debugging email messages.

  • AdminEmail Outbox

Check if the API token email is showing up under Sent:

Outbox

Email debug

Simscope will dump SMTP email delivery failures to the terminal for debugging.


Deleting unsent emails

Simscope will automatically re-try sending unsent emails for a week, and then prune any email if it fails afterward.

If you want to manually delete an unsent email:

  • Click Admin → Email Outbox
  • Click any unsent email.
  • In the top-right corner, click Delete Email