This guide is applicable for versions 24.3 and up. Follow the link for older SDK reference guides for v24.2 and lower

ftos.messaging.send

IMPORTANT!
Starting with v24.3.0, this is renamed from sendMail to ftos.messaging.send.

Sends an email using a predefined template. It uses the MessageQueue entity to store the email body.

Emails are sent:

using the optional providerName parameter (starting with v24.3)
if providerName is not specified, asynchronously using job servers after EmailChannelProviderName is enabled in the Configuration Manager (starting with 22.9.1)
a valid SMTP server configured in the web service (for v22.1.8 and prior).
using the channelProviderName parameter (starting with v24.3.2) through SMTP. Make sure you do the configurations described in the Configuration Manager page.

This is suitable for business logic modules of business service components.

Syntax

For v24.3.1 and before:

Copy

function ftos.messaging.send(templateName: string, to: string[], tokens: any, attachments: any,  cc: string[], string providerName): void

For v24.3.2 and above:

Copy

function ftos.messaging.send(templateName: string, to: any, tokens: any, attachments: any,  cc: any, channelProviderName:string): void

Parameter	Description
`templateName`	Name of a predefined email template to be used.
`to`	Recipient's email address.
`tokens`	Keys for substitution. They are defined as properties of an object and replaced with their values. Tokens are enclosed in brackets in the email template body (e.g., {accountName}).
`attachments`	The files to be attached to the email. This is a JSON object with its key-value pairs representing: key – The name of the file as it will be attached to the email. When attaching multiple files, you must provide unique names for each of them. value – Unique internal ID of the corresponding file (real name) as it is stored on the FintechOS server. Both names should include the file extension.
`cc`	Array of strings containing the Carbon Copy email recipients.
`providerName`	Available with v24.3.1. If this parameter is not passed or is null/empty, then the provider specified in Configuration Manager key EmailChannelProviderName is used.
`channelProviderName`	Available starting with v24.3.2. If this parameter is not passed or is null/empty, then the provider specified in Configuration Manager key EmailChannelProviderName is used.

Examples

Send a predefined welcome message

In this example:

We send an email message based on the welcomeTemplate.
The recipients of the message are john.doe@gmail.com and jane.doe@gmail.com.
A copy of the message is sent to marketing@mycompany.com.

Copy

ftos.messaging.send('welcomeTemplate', ['john.doe@gmail.com', 'jane.doe@gmail.com'], {}, {}, ['marketing@mycompany.com']);

Send a customized message which contains tokens and an attachment

In this example:

We send a customized offer based on the offerTemplate.
The recipient of the message is john.doe@gmail.com.
The accountName token from the message template is replaced with the customer's name (John).
The termsAndConditions_ddde85d9-ca38-42b8-b6b9-e5cc6bb4078c.pdf file is attached to the email under the TermsAndConditions.pdf name.

Copy

ftos.messaging.send('offerTemplate', ['john.doe@gmail.com'], {accountName: 'John'}, {'TermsAndConditions.pdf': 'termsAndConditions_ddde85d9-ca38-42b8-b6b9-e5cc6bb4078c.pdf'},[]);