Stop the war

Stand with Ukraine flag

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 MQTT Broker
Getting Started Documentation Devices Library Guides Installation Architecture API FAQ

Mail Plugin

Doc info icon
Important note

Please note that this guide is for ThingsBoard versions prior v2.0.

Old rules and plugins functionality is replaced by new rule engine components (rule chains and rule nodes).

Please review new rule engine documentation to learn how to adopt new functionality.

We are doing our best to modify this guide to v2.0 components. Contributions are welcome.


Mail plugin is responsible for sending email messages that are triggered by corresponding rule actions.


You can specify following parameters:

  • mail server host
  • mail server port
  • user name
  • password
  • map with other properties. See java mail sender for more details.

Server-side API

This plugin does not provide any server-side API.


As a tenant administrator, you are able to review plugin example inside Plugins->Demo Email Plugin that is configured to Gmail server. You may want to update username and password to match existing account and start receiving emails.