SendEmailNodeEditor Documentation
Purpose
The SendEmailNodeEditor is a component within the Vantage analytics and data platform that allows users to configure email notifications based on the output of a workflow. This editor enables users to specify recipient email addresses, customize the subject line, select a body format, and input a custom body template if desired. It streamlines the process of sending formatted emails directly from the platform, enhancing communication and reporting capabilities.
Settings
1. Recipient Email(s)
- Name:
to - Input Type: String
- Description: This setting allows users to specify one or more recipient email addresses. Emails should be listed as a comma-separated string. This can include a maximum of 50 email addresses.
- Default Value:
""(empty string)
Changing this field updates the addresses to which the email will be sent. If left empty, no emails will be sent.
2. Subject
- Name:
subject - Input Type: String
- Description: This setting specifies the subject line of the email. Users can input any string that summarizes the content of the email.
- Default Value:
""(empty string)
Changing the subject line will affect how the email is perceived by recipients, providing context about the email's content.
3. Body Format
- Name:
bodyFormat - Input Type: Dropdown
- Description: This setting allows users to choose the format of the email body between "Plain Text" and "HTML". If "Plain Text" is selected, the body will be formatted as simple text. If "HTML" is chosen, any HTML content will be rendered as provided.
- Default Value:
"text"(Plain Text)
Changing this setting affects the rendering of the email content. HTML format allows for richer formatting options, while Plain Text is simpler and more universally compatible.
4. Custom Body Template
- Name:
bodyTemplate - Input Type: String
- Description: Users can input a custom body template for the email. This field is optional; if left blank, the input data will be auto-formatted into a summary table.
- Default Value:
""(empty string)
The content of this field directly influences the email's body. If HTML is selected as the body format, the entered HTML will be sent as-is. For Plain Text, the provided string will be wrapped in the Vantage email template.
How It Works
When a user selects the SendEmailNodeEditor, it presents a form through which they can configure the aforementioned settings. Upon submitting the configuration, the information is used to format and send an email notification when the workflow is executed. The component captures user input and communicates changes through the updateField function, which updates the corresponding configuration state.
Data Expectations
The SendEmailNodeEditor expects the following data inputs:
- A list of recipient email addresses (maximum of 50)
- A subject line string
- An optional body format choice ("text" or "html")
- An optional custom body template as a string
Emails will be sent from a specified sender address (noreply@intuidy.com). If no custom body is provided, the input data is auto-formatted, ensuring that information remains consistent and organized.
Use Cases & Examples
Use Case 1: Automated Reporting
A business uses the SendEmailNodeEditor to send weekly reports to their management team automatically. The reports include performance metrics generated from various workflows.
Use Case 2: Customer Notifications
A company wants to notify customers about order statuses or account updates. The editor can be configured to send personalized emails to relevant customers whenever there is a change in their account.
Use Case 3: Alerting IT Teams
An IT department configures this node editor to receive alerts when system metrics cross certain thresholds. Emails containing the output from monitoring workflows keep the team informed in real time.
Example Configuration
For the case of Automated Reporting, the configuration could be set as follows:
- Recipient Email(s):
manager@example.com, director@example.com - Subject:
Weekly Performance Report - Body Format:
html - Custom Body Template:
"<h1>Performance Metrics</h1><p>This week we achieved exceptional results: {{metrics}}</p>"
Here, the email will be sent in HTML format with a personalized greeting and summary of the performance data, enhancing clarity and presentation for the recipients.