Skip to main content
Version: 2.13.0

Sending an email with attachments

To use the notification plugin for sending emails with attachments, you must define the same topic configuration as for sending regular notifications. A notification template must be created, and the corresponding Kafka topics must be defined.

ยปSend a notification

Defining process actionsโ€‹

Example: send an email notification with attached files from a business flowโ€‹

Let's pick a simple use-case. Imagine we need to send a copy of a contract signed by a new customer. Before setting the action for the notification, another action must be defined, so the first one will save the new contract using the documents plugin.

ยปUploading a new document

The steps for sending the notification are the following:

Step 1: Configure the template that you want to use for the email, see the Managing notification templates section for more information.

Step 2: Check that the needed topics are defined correctly on the following environment variables:

KAFKA_TOPIC_NOTIFICATION_INTERNAL_IN

KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT

Step 3: Use the FLOWX.AI Designer to add a new Kafka send event action to the correct node in the process definition.

Step 4: Add the proper configuration to the action, the Kafka topic and message to be sent.

The message to be sent to Kafka will look something like:

{
"templateName" : "contractCopy",
"identifier" : "text",
"language": "en",
"receivers" : [ "someone@somewhere.com" ],
"contentParams" : {
"clientId" : "clientId",
"firstName" : "first",
"lastName" : "last"
},
"attachments" : [ {
"filename" : "contract",
"path" : "MINIO_BUCKET_PATH/contract.pdf"
} ]
}

Was this page helpful?