Stop the war

Support Ukraine

Try it now Pricing
Community Edition
Community Edition Professional Edition Cloud Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application
Documentation > Administration UI > Mail Settings
Getting Started
Devices Library Guides Installation Architecture API FAQ

On this page

Mail Settings

ThingsBoard System Administrator is able to configure a connection to a SMTP server that will be used to distribute activation and password reset emails to users. This configuration step is required in production environments. If you are evaluating the platform, pre-provisioned demo accounts are sufficient in most of the use cases.

NOTE:
System Mail settings are used only during user creation and password reset process and are controlled by a system administrator. Tenant administrator is able to setup email rule node to distribute alarms produced by rule engine.

Mail Server configuration

Following steps are required to configure Mail Server settings.

First, you must login to your ThingsBoard instance WEB UI as a system administrator. Then, right click on the burger in the top-right corner of the WEB UI and select ‘Profile’. Change ‘[email protected]’ to your email address. Now re-login as administrator again.

image


Now we need to configure SMTP server.

This guide provides examples of configure SMTP server using Sendgrid and Gmail. In your configuration you can use any other SMTP server.

Sendgrid configuration example

SendGrid configuration is fairly simple and straightforward. First, you need to create SendGrid account. You can try it for free and the free plan is most likely enough for platform evaluation.

Once you create your account, you will be forwarded to the welcome page.

image

Go to the ‘Integration Guide’ page and choose ‘SMTP Relay’.

image

Populate the API key name and generate it.

image

Now navigate to the ‘Settings’ page -> ‘Mail Server’ tab your ThingsBoard instance and populate the form. Update ‘Mail From’ field, copy tthe data from the SendGrid page and paste to the Thingsboard mail server settings form.

  • SMTP host: smtp.sendgrid.com;
  • SMTP port: 465;
  • Username: apikey;
  • Password: previously generated password.

Note that you can also enable/disable TLS using checkbox.

Click on ‘Send test mail’ button.

image

Once you receive test mail on your email, save Mail Server configuration. In case of error in configuration, you should receive a popup with the error log.

You can also complete verification on the SendGrid website.

image

Gmail configuration example

In order to use Gmail, you will need to enable two-step verification (this step is not mandatory, but it is highly recommended.) and generate an app password.

Once this is ready, you should be able to setup mail server using the information below:

  • SMTP host: smtp.gmail.com;
  • SMTP port: 465;
  • Username: your email;
  • Password: previously created app password.

You can also enable/disable TLS using checkbox.

Click ‘Send test mail’ button.

image

Once you receive test mail on your email, save Mail Server configuration. In case of error in configuration, you should receive a popup with the error log.