E-Mail Notifications

Configuring SMTP server

Squore allows users to configure automatic sending of e-mail notifications at the end of an analysis. In order to use this feature, Squore Server must be configured to communicate with an SMTP server.

Before you start, ensure that the following details are available:

The URL and port of your SMTP server
The username and password used to authenticate against the SMTP server
The e-mail address that you want to see used in the from field of the e-mails.

In order to configure the SMTP server integration:

Edit <SQUORE_HOME>/server/standalone/configuration/standalone.xml, find the mail-session configuration, which by default looks like this:
```
<smtp-server outbound-socket-binding-ref="mail-smtp"/>
```

Complete the element to add in the username and password for the smtp server, and optionally turn on ssl:

<mail-session name="default" jndi-name="java:jboss/mail/Default">
  <smtp-server outbound-socket-binding-ref="mail-smtp" ssl="false" username="login" password="password"/>
</mail-session>

Find the outbound-socket-binding element with the name attribute mail-smtp and edit the remote-destination sub-element as needed:
```
<outbound-socket-binding name="mail-smtp">
    <remote-destination host="localhost" port="25"/>
</outbound-socket-binding>
```
Start Squore Server.
Log in as administrator and go to Administration > System.
Set the value of the FROM e-mail address for notifications, as well as the Squore Server URL to be used in body of the e-mails, for example squore@domain.com and http://localhost:8180.

Project analysis notifications

Squore allows to configure e-mail notifications template, than can then be used to notify users part of a project’s team that an analysis has been completed, successfully or not.

These templates are defined in the model configuration, and are then activated or not in the project creation wizard.

You will find more information about how to configure such templates in the Notifications of the Configuration guide.

Maintenance notifications

Squore also allows notifying all users by e-mail when planned maintenance is necessary.

Figure 1. The E-mail form to notify all users available to administrators

If you already have configured the SMTP server as explained in Configuring SMTP server, follow these steps to send a maintenance e-mail:

Log in as administrator.
Click Administration > System
Click on Notify users by e-mail.
Type a message subject and content and click Send to e-mail users.

The e-mail notification will be sent to all selected users that have an e-mail address.

Squore will actually limit the amount of recipients to 100 per e-mail, and send more than one e-mail if necessary. If this number of recipients is too high for your SMTP server, you can configure the maximum number of recipients to include in a single e-mail by setting the mail.recipients property in <SQUORE_HOME>/server/standalone/configuration/squore-server.properties:

mail.recipients = 100