Skip to main content
Version: 🚧 Next

send-email-to-dossier-recipient

title: "Send Mail To Configurable Dossier Recipient"​

Send Mail To Configurable Dossier Recipient

Business goal​

This action sends an email to one or more recipients related to a dossier. It supports both dynamic recipients (like the dossier's assignee or owner) and a list of static email addresses.

This action is useful for notifying key stakeholders when a dossier reaches a certain point in its lifecycle (e.g., "Send an email to the dossier assignee and a static compliance mailbox when the status changes to 'Pending Review'").

Configuration​

  1. Add the action SendMailToDossierRecipient.
  2. Link this action to an appropriate event or status transition (e.g., a DOSSIER_STATUS_CHANGED for a specific status).
  3. Configure the settings (see below) to define who receives the email and what template to use.

Settings​

Settings Configuration

Examples

Required Settings​

  • emailTemplate: (Required) Specifies the system or custom email template to use. Make sure to configure translations for the template codes (EMAIL_<templateName>_SUBJECT and EMAIL_<templateName>_BODY).
  • Note:
    • Configure translations for email template using EMAIL_emailTemplate_SUBJECT (subject) and EMAIL_emailTemplate_BODY (HTML body).
    • Ensure each of these keys includes translations for all languages in which the email should be available.
  • dynamicEmailRecipients: A list of dynamic recipient identifiers to be resolved from the dossier (e.g., "ASSIGNEE").
  • staticEmailRecipients: A list of fixed email recipients, each with a name, email, and language.
  • Note:
    • At least one dynamicEmailRecipients or one staticEmailRecipients must be provided.
    • If multiple dynamic or static recipients resolve to the same email address, the email will only be sent once.
    • If no email is sent to any recipient because their email address or language could not be resolved, this action will be marked as failed.

Optional Settings​

  • associatedPartyFilter: (Optional) If provided, the email will only be sent if the dossier has at least one associated party that matches this filter. More details here
  • dossierFilter: (Optional) If provided, the email will be sent only if the dossier satisfies the filter criteria. More details here
  • failOnError: (Optional) Marks the event as failed and stops subsequent actions when an exception occurs.
  • reportFailure: (Optional) Sends an error report (e.g., email) when the action ends in failure.
  • retryFailure: (Optional) Retries the action automatically when it fails.
  • enableSelfNotification: (Optional) Controls sending emails to user who triggered the action and are also listed as recipients. Default Set to true to allow sending notifications to the executor themselves.

Dynamic Recipient Identifiers​

The following enum are supported in the dynamicEmailRecipients list:

IdentifierDescription
"ASSIGNEE"The current assignee of the dossier.
"OWNER"The owner of the dossier. (the user who created the dossier)
"RESPONSIBLES"All the responsible party/contact of the dossier.
"FSP_MAIL"The main FSP email address linked to the dossier.
"MAIN_RESPONSIBLE"The main responsible of a dossier.

Main Responsible of a Dossier​

The MAIN_RESPONSIBLE of a dossier is determined as follows:

  • If the dossier has exactly one responsible, that party is considered the main responsible.
  • Otherwise, the system selects a party with responsibility code GOALS.
  • If no GOALS responsibility is found, it falls back to a party with responsibility code UBO.

Static Recipient Properties​

Each object in the staticEmailRecipients list has the following structure:

  • email (string): (Required) The email address to send to.
  • fullName (string): (Required) The full name of the recipient.
  • languageIsoCode : (Optional) The language of mail for specific recipient, e.g. "en". The language must be supported by the application have translations defined for the configured email template.