HyperPortal - email support

There is the possibility to use email sending from the workflows as an automated task, as well as in particular situations (e.g., import/export result), or programmatically via code. Email infrastructure is mostly based on AWS SES.

Emails templates can be constructed via an external integrated plugin called Stripo that allows each tenant to have multiple templates that can be used when sending emails - https://<TENANT_ID>.hyperportal.org/emails/templates.

Templates use handlebars as a templating engine. More information on the specific handlebars config in AWS can be seen in the documentation: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-advanced.html

Important to note that in the platform you can preview the email and set default parameters for when variables are not defined.

Within the workflows, you can insert a node responsible for the automated sending of an email. Besides the common and expected properties of reply-to, to, cc, bcc; there is also the advanced template selection based on workflow property values (template mapping property).

When executing, the email templating engine is fed with the full expanded process data.

Code for this functionality exists in the mail microservice within the lambdas-monorepo repository.

There are available lambdas for sending emails via API and internal invocation.

In order to send an email via SES, the domain to be used needs to be verified, as well as any specific email addresses

You can also check in the console, statistics of all sent emails (deliveries, rejects, bounces, complaints): https://eu-west-1.console.aws.amazon.com/ses/home?region=eu-west-1#dashboard:

Correct use of email sending is very important because of reputation. Spamming CANNOT be done using SES or via our personal or our client domains. If you notice that any client is using our platform for spamming, cease immediately his use of emailing functionality. It is highly important to keep track of the reputation of our account.

If any client complains that an email does not reach its destination, have a look at the suppression list: https://eu-west-1.console.aws.amazon.com/ses/home?region=eu-west-1#suppressionlist-removal:

We rely on SES templates to send most of our platform emails, and those are stored in the SES template repository: https://eu-west-1.console.aws.amazon.com/ses/home?region=eu-west-1#email-templates-list:

In order to configure environment events and sending IPs, configuration sets can be used. We have currently split staging and production environments - https://eu-west-1.console.aws.amazon.com/ses/home?region=eu-west-1#configuration-set-list: - check the code to understand which one is used.