Email V2

Discover more about the Email V2 connector and how to use it on the Digibee Integration Platform.

The Email V2 connector enables you to send simple emails in HTML format, with or without attachments.

Parameters

Configure the connector using the parameters below. Fields that support Double Braces expressions are marked in the Supports DB column.

Parameter

Description

Data type

Supports DB

Default value

Visible when

Alias

Name (alias) for this connector’s output, allowing you to reference it later in the flow using Double Braces expressions.

String

✅

email-v2-1

—

Account Type

Type of account used for authentication. Supported: Azure Key and Basic.

String

❌

Basic

—

Use Dynamic Account

If enabled, the connector uses the account dynamically via the Store Account connector; otherwise, it uses the account statically as configured in Accounts on the Platform.

Boolean

❌

false

—

Scoped

If enabled, isolates the stored account from other sub-processes. Not supported for accounts used in headers or body. To learn more, read the Dynamic Accounts documentation.

Boolean

❌

false

Use Dynamic Account is enabled

Account Name

Name of the account defined in the Store Account connector.

String

✅

N/A

Use Dynamic Account is enabled

Account

Account used to authenticate with the email server. Required if the service requires authentication. Must be an Azure Key or Basic account type, configured in Accounts on the Platform.

String

❌

N/A

Use Dynamic Account is disabled

SMTP Host

SMTP server host. Example: smtp.gmail.com

String

✅

smtp.gmail.com

—

SMTP Port

SMTP server port. Commonly 587, but may vary.

Integer

✅

587

—

From

Sender's email address.

String

✅

N/A

—

Recipient email address(es), separated by commas.

String

✅

N/A

—

CC recipient(s), separated by commas.

String

✅

N/A

—

BCC

BCC recipient(s), separated by commas.

String

✅

N/A

—

Subject

Email subject line.

String

✅

N/A

—

Charset

Character set for the email body.

String

UTF-8

—

Content

Email body. Supports Freemarker templates for dynamic HTML.

String

✅

N/A

—

Custom Attachments Specification

Enables raw attachment input and hides the form-based attachment field.

Boolean

❌

false

—

Attachments

Email attachments. Specified via form or raw array.

Array of objects

❌

N/A

Custom Attachments Specification is enabled

Authenticated

Enable if SMTP authentication is required.

Boolean

❌

true

—

Is Over TLS

Enable to send the message over TLS.

Boolean

❌

true

—

Is Over SSL

Enable to send the message over SSL.

Boolean

❌

false

Is Over TLS is disabled

Socket Port

Required if SSL is enabled. Specifies the port used.

Integer

✅

N/A

Is Over SSL is enabled

Force TLSv1.2

Forces TLS 1.2 for secure email server connections.

Boolean

❌

false

—

Fail On Error

If enabled, interrupts the pipeline execution when an error occurs. If disabled, execution continues, but the "success" property will be set to false.

Boolean

❌

fals

—

To embed images in the email body, use the prefix cid: followed by the image name in the Attachments parameter. Example: <img src="cid:image.png" />

Message Flow

Input

No specific input is required unless a Double Braces expression is used in any field.

Output

The connector returns a JSON object like the one below:

{
  "from": "a@a.com",
  "to": "a@a.com,a@a.com.br",
  "cc": "a@a.com,a@a.com.br",
  "bcc": "a@a.com,a@a.com.br",
  "subject": "Subject",
  "content": "<html>Test Email!</html>",
  "charset": "UTF-8",
  "success": true,
  "attachments": [
    {
      "type": "ATTACHMENT",
      "attachment": "attachment.extension"
    }
  ]
}

Field explanations:

from: Sender email
to: Recipients
cc: CC recipients
bcc: BCC recipients
subject: Email subject
content: Email body (truncated if over 256 characters)
charset: Character encoding used
success: Indicates if the message was sent successfully
attachments: List of attachments

Files are handled securely within a temporary directory exclusive to the pipeline.

Learn more about Messages processing in the Digibee Integration Platform.

Email V2 in action

Authentication

Email V2 supports the following authentication methods:

Basic

Use a Basic account where the username is the sender’s email and the password is the corresponding email password.

OAuth 2

Currently supported only for Microsoft-based (Outlook) email accounts.

To configure:

Set the From field with the sender's email address.
Choose an Azure Key that contains the necessary credentials.

Internally, the connector uses client-id, client-secret, and tenant-id to generate a token, which is used along with the sender email to authenticate with the SMTP server.

Example: Email with attachments and inline image (RAW mode)

Configuration:

SMTP Host: smtp.gmail.com
SMTP Port: 587
From: email@gmail.com (the same email configured in the Account parameter)
To: some_other_email@gmail.com, second_email@gmail.com
Subject: Hello
Content:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <title>Demystifying Email Design</title>
  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
</head>
<body>
<img src="cid:myImage.png" />
</body>
</html>

Authenticated: true
Is Over TLS: true
Attachment As Raw: true
Attachments:

[
  { "type": "INLINE", "attachment": "myImage.png" },
  { "type": "ATTACHMENT", "attachment": "xpto.txt" }
]

Output:

{
  "from": "email@gmail.com",
  "to": "some_other_email@gmail.com,second_email@gmail.com",
  "cc": "",
  "bcc": "",
  "subject": "Hello",
  "content": "<!DOCTYPE html PUBLIC ...TRUNCATED",
  "charset": "UTF-8",
  "success": true,
  "attachments": [
    { "type": "INLINE", "attachment": "myImage.png" },
    { "type": "ATTACHMENT", "attachment": "xpto.txt" }
  ]
}

Dynamic email example using Double Braces expressions

You can use Double Braces expressions to insert variables dynamically into your email configuration.

In the example below, we first configured the JSON Generator (Mock) with the following data:

JSON data:

{
  "sender": "digibee@gmail.com",
  "recipient": "digi@gmail.com",
  "recipient_cc": "digi1@gmail.com",
  "recipient_bcc": "digi2@gmail.com",
  "port": "587",
  "host": "smtp.gmail.com",
  "INVOICE": "98787979789",
  "DUE_DATE": "01/13/2023"
}

Next, we configured the Email V2 connector using Double Braces expressions to reference these values:

SMTP Host: {{ message.host }}
SMTP Port: {{ message.port }}
From: {{ message.sender }}
To: {{ message.recipient }}
CC: {{ message.recipient_cc }}
BCC: {{ message.recipient_bcc }}
Subject: {{ CONCAT("Invoice ", FORMATDATE(NOW(), "timestamp", "MMMM yyyy", null, "UTC", "pt-BR", "GMT-3")) }}
Charset: UTF-8: Eight-bit Unicode (or UCS) Transformation Format
Content:

<!DOCTYPE html>
<html>
<head>
  </head>
<body>
 
Good afternoon, <br/>
Below is the invoice <a href='${INVOICE}'>(Click here)</a> referring to the monthly license fee for the platform – due for <b> ${DUE_DATE}</b>. <br/>
Payment will be via <b>bank transfer</b> - given in the body of the invoice. <br/><br/>


Please, confirm the receipt. <br/>
Any questions, we are available. <br/><br/>
  <br/>
  <br/>
Att.,
Customer relationship
</body>
</html>

Technology

The connector uses Freemarker for dynamic content generation.

PreviousWeb protocols NextEmail V1 (Deprecated)

Last updated 15 days ago

Was this helpful?