Email configuration

The SMTP server is used to forward Email notifications for events on Sales Transactions, Part updates, etc.
Setting up the SMTP server is optional, but highly recommended for production use.

 

By default, all emails are saved into files and served under <SERVER_IP>/en/admin/django_mail_admin/outgoingemail/outgoingemail/. This functionality can be used for evaluation or testing purposes. For production usage we recommend utilizing an external/organizational mailing server.

 

The SMTP server can be configured in 4 different modes for email backend:

  • smtp: standard SMTP backend

  • smtpssl: SMTP backend for use with Amazon Simple Mail Service / Gmail

  • db: Saves the emails in database that are server under /en/admin/django_mail_admin/outgoingemail/

  • console: Print all emails to the logs

emailConfig: # if set to true, the app will attemtp to send emails using the configure smtp server # if set to false, emails will be sent using a dummy backend that shows all emails under /mails/ enabled: false # The connection parameters for the SMTP server that should be used to send E-Mails. backend: smtp fromAddress: host: enableEmailAuthentication: true user: password: port: 465 useTLS: false useSSL: true

Settings Key

Possible Values

Description

Settings Key

Possible Values

Description

enabled

true or false

Enable or Disable SMTP notifications

backend

smtp, smtpssl db, console

Configure the backend mode

fromAddress

Email Address

The default email sender address. It can be overwritten in the admin panel

host

IP or Hostname

The IP or host of the SMTP server

enableEmailAuthentication

true or false

Enable or Disable email authentication

user

Any String

Any random string/leave blank

password

Any String

Any random string/leave blank

port

Numerical Port

The port where the SMTP server is listening

useTLS

true or false

Whether or not an explicitly encrypted TLS connection is used

useSSL

true or false

Whether or not an implicitly encrypted SSL connection is used

The settings useTLS and useSSL are mutually exclusive. You can only have one of both set to true. Which one to use depends on the mail server you are connecting to. In general, the following guidelines apply:

  • if  port: 25 set:

useTLS: false useSSL: false
  • If port: 465 set:

useTLS: false useSSL: true
  • If port: 587 set:

 

 

After editing the SMTP configuration, verify the correctness of the changes and save the values.yaml file. Apply the changes with this:

 

After the upgrade is complete change the Email From Address to match the platform domain in the Admin Panel / Organization Theme / Email Footer section.

 

Test the emails by Signing up an

 

Troubleshooting:
The email notifications logs can be followed in the celery container logs.

 

Example of a successful email notification

 

Example of timeout from the SMTP server