Email Component

The Email Component enables pipelines to send emails in a specified format to one or multiple recipients. It supports plain-text and HTML bodies, secure transmission options, and the ability to attach event data.

Key Capabilities

  • Send emails to single or multiple recipients.

  • Compose messages with HTML editor for rich formatting.

  • Optionally attach in-event data.

  • Support for SSL/TLS encryption with SMTP.

  • Configure sender details with SMTP authentication.

  • Disable email sending during testing or dry runs.

Configuration Overview

All Email Component configurations are grouped into:

  • Basic Information

  • Meta Information

  • Resource Configuration

Configuring Meta Information

Message Settings

  • Subject – Enter the subject line of the email.

  • HTML Editor – Compose the email body (supports HTML for formatting).

  • Attachment – Choose whether to send in-event data as an attachment (Yes/No).

  • Receivers – Provide one or more recipient email addresses.

    • For multiple recipients, separate addresses with commas.

Security Settings

  • TLS – Enable/disable Transport Layer Security by checking the box.

  • Encryption Type – Select the encryption protocol:

    • SSL

    • TLS

    • None

SMTP Server Settings

  • Email Username – Email account configured with the SMTP server.

  • Email Password – Password for the configured email account.

  • Email From – Sender’s email address registered with the SMTP server.

  • Email Port – SMTP port number (e.g., 465 for SSL, 587 for TLS).

  • Enable SSL – Enable SSL encryption if required by the server.

Additional Options

  • Disable Email Sending – Use this option to stop actual email delivery (useful for testing).

  • Email Input – Select input fields from event data to pass into the email body.

Usage Notes

  • Ensure SMTP credentials and server details are correctly configured before enabling email sending.

  • Use Email Input fields for dynamic values (e.g., insert customer names or transaction IDs into the message body).

  • For production systems, always use TLS or SSL encryption for secure communication.

  • Test with a single recipient before enabling multiple recipients.

Example Use Cases

  • Send a failure alert email with event logs attached.

  • Deliver daily summary reports as HTML emails with charts or tables.

  • Notify multiple stakeholders when a scheduled job completes successfully.

  • Forward in-event data (transactions, metrics) as a CSV attachment.

PreviousAlertsNextJob Trigger