Board Mailer Service

Document created by andreamo Employee on Aug 26, 2019Last modified by davidegenini on Oct 7, 2019
Version 3Show Document
  • View in full screen mode

FUNCTIONALITY

The Mailer is the service responsible of sending emails when using the Board functionalities of Broadcasting, Subscription and Send-To.

To activate it, it is necessary to configure the correct parameters within the following files located in the Board Web Server file system:

  • Broadcasting.config
  • Board.Mailer.Service.exe.config
  • Mailer.config

 

HOW TO CONFIGURE IT

Broadcasting.config

Path: C:\Program Files (x86)\Board\Board WebApi Server\App_Data\config\broadcasting.config

 

The file contains the following fields:

Key nameFunctionMandatory
internalSmtpAddressFQDN of SMPT server used to send automatic emails.X
internalSmtpPortPort used by the SMTP server X
internalSmtpEnableSslFlag to enable/disable SSL encryption. Accepted values: on or off.
mailerUsernameUser used to authenticate on SMTP server
mailerPasswordPassword of SMTP server user
workingFolderPhysical folder on the web server where temporary files are generated before being sent as attachments in the emailsX
mailerSenderEmail sender address that will be displayed in the received emails
pollingMinutesFrequency (in minutes) at which the broadcasting service checks if there are requests to be processed

 

Board.Mailer.Service.exe.config

Path: C:\Program Files (x86)\Board\Board WebApi Server\Board.Mailer.Service.exe.config

 

 

A missing or incorrect configuration of this file can typically result in the generation of the following Windows error when attempting to start the Board Mailer Service: "1053 - The server did not       

respond to the start or control request in a timely fashion."

 

The content of this file has changed with version 10.5.1 and the different configurations are detailed below:

 

Board 10.5.0 and Board 11.0

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2"/>
</startup>
<appSettings>
<add key="WatchPath" value="C:\Program Files (x86)\Board\Board WebApi Server\App_Data\broadcasting"/>
<add key="LogFolder" value="C:\Program Files (x86)\Board\Board WebApi Server\App_Data\broadcasting\log"/>
</appSettings>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-10.0.0.0" newVersion="10.0.0.0"/>
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>

 

Where:
- WatchPath: it contains the files that Board Mailer Service will attach to emails and must be the same path set as WorkingFolder in broadcasting.config (MANDATORY)
- LogFolder: Board Mailer Service log folder (MANDATORY)

 

Board 10.5.1, Board 11.1 and future versions

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<appSettings configSource="App_Data\config\mailer.config"/>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2"/>
</startup>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-10.0.0.0" newVersion="10.0.0.0"/>
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>

 

Where:
- App_Data\config\mailer.config: is the file containing the settings of the mailer service

 

Mailer.config

Path: C:\Program Files (x86)\Board\Board WebApi Server\App_Data\mailer.config

 

The content of the file looks as follows:

<appSettings>
<add key="webUrl" value="http://localhost:80/"/>
<add key="WatchPath" value="C:\Program Files (x86)\Board\Board WebApi Server\App_Data\broadcasting"/>
<add key="LogFolder" value="C:\Program Files (x86)\Board\Board WebApi Server\App_Data\broadcasting\log"/>
</appSettings>

 

Where:
- WatchPath: it contains the files that Board Mailer Service will attach to emails and must be the same path set as WorkingFolder in broadcasting.config (MANDATORY)
- LogFolder: Board Mailer Service log folder (MANDATORY)
- webUrl: is the URL used by Web Clients to access Board, as set in the key “host” of the file C:\Program Files (x86)\Board\Board WebApi Server\App_Data\config\appSettings.config like in the example below (MANDATORY)

 

 

UPGRADING NOTES

When upgrading the Board WebApi Engine to version 10.5.1 the config file mailer.config need to be manually added to the App_Data/config folder. The file mailer.config must be configured as shown above.

Attachments

    Outcomes