Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

The integrated Messenger messenger module of the NETx BMS Core Server allows to add email that can be used to send Alarms, Conditions or Timed notifications. send an email in an action used in an alarm or a scheduler event.

Prerequisites

  • An

    Email

    email address is required.

  • Enabling SMTP

    Access

    access allows you to send email through your own mail server.

  • For Gmail enable Less secure access.

...

Core Server configuration

Open the the menu Modules → Messenger → [Live] Email configuration within the Messenger Module menu entry and add a new definition (right click , / Insert new definition).Image Removed

...

In the Email Definitions you will need to insert a new definition. Provide the following information for an email profile:

Field

Description

Profile

The profile name.

From

An email address identifies an email box to which email messages are delivered

The email address used in the from field of a sent mail.

Host

An email hosting service

Host name or IP address of the SMTP server.

Port

Hosting

SMTP service port number.

UseAuthentication

Login flag

Enable to login to the SMTP server. Disable for anonymous access.

Username

Email

Login for the SMTP server (typically email or user name

used for login

).

Password

Login

Password

password.

UseSsl

SSL Flag.

...

Set to true if the SMTP connection shall use TLS.

DefaultRecipient

Recipient e mail address if recipient parameter is not used in XLogic command.

Example of an email profile:

Image Removed

This email definition can be applied by Profile name.

...

Send a test

...

email

As mentioned in the Messenger module configuration, NETx BMS Platform ships with a pre-built messenger Commands.
We XCommands is available. We can use the "MESSENGER.SENDEMAIL" Command  XCommand to send a test email.

Select the "In the Core Studio menu, select Tools → Run XCommand..." menu entry within the "Tools" menu entry of the NETx BMS Core Studio.

Image Removed

...

Image Removed

Click "Execute". You should get  menu entry. Select the MESSENGER.SENDEMAIL Command. Provide the messenger mail profile name, the recipient's email address, the subject, a body and an optional attachment (note: if the profile name does not exist or if this parameter is blank, the first found Email definition will be used.)

...

Click Execute to send the email. You should receive an email from the configured Profileprofile's email to the destination email. Image Removed

...