Email V2

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

Email V2 allows you to send simple emails, in HTML format or even with attachments.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter

Description

Default value

Data type

Account

Necessary for the component to make the authentication of the email server to be used in the dispatch, in case this email service is requested in the authentication.

N/A

String

SMTP Host

SMTP host of the email server. Eg.: (Gmail: smtp.gmail.com)

smtp.gmail.com

String

SMTP Port

SMTP port of the email server. Port 587 is generally used, but it can vary according to the email server.

587

Integer

From

Email sender.

N/A

String

Email recipient. If there're multiple recipients, they must be separated by comma. Eg: a@a.com,b@b.com,....

N/A

String

Recipients who will receive a copy of the email. If there're multiple recipients, they must be separated by comma. Eg: a@a.com,b@b.com,....

N/A

String

BCC

Recipients who will receive a hidden copy of the email. If there're multiple recipients, they must be separated by comma. Eg:a@a.com,b@b.com,...

N/A

String

Content

Email body. It accepts the use of Freemarker templates to generate dynamic HTML.

N/A

String

Charset

Charset to be used in the email body dispatch.

UTF-8

String

Subject

Subject of the email.

N/A

String

Authenticated

If the option is enabled, it's mandatory to provide an account with email and password for authentication. If not needed, keep it disabled.

True

Boolean

Is Over SSL

If enabled, the dispatch is made via SSL.

True

Boolean

Socket Port

If Is Over SSL is enabled, inform the port used to traffic the message via SSL.

N/A

Integer

Is Over TLS

If enabled, the dispatch is made via TLS.

False

Boolean

Force TLSv1.2

Sets the use of TLS V1.2 as mandatory for connections with email servers.

False

Boolean

Custom Attachments Specification

If enabled, the form to add attachments will be hidden, and the dispatch in RAW mode may be used, through which you inform the attachments array.

False

Boolean

Attachments

Message attachments. The specification is made via form.

N/A

Options of Custom Attachments Specification / Array of Objects

Fail On Error

If enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for "success."

False

Boolean

In the Attachments parameter, to add images inside the email body, the "cid:" prefix must be informed before the image name. Eg.: <img src"cid: image.png" />

Messages flow

Input

This component doesn't expect any specific input message, only if an expression in Double Braces is informed in some of its fields.

Output

When executing an Email V2 component, the following JSON structure will be generated:

{
    "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"
    }]
}

from: sender.
to: recipients.
cc: recipients in copy.
bcc: recipients in hidden copy.
subject: subject.
content: message body. If the message body exceeds 256 characters, the result will be truncated.
charset: charset.
success: if the message is well succeed.
attachments: array with the sent attachments.

The files manipulation inside a pipeline occurs in a protected way. The files can be accessed in a temporary directory that only the pipeline under deployment has access to.

To better understand the messages flow in the Digibee Integration Platform, read our article about Messages processing.

Email V2 in Action

See below how the component responds to a determined situation and its respective configuration.

Sending a text file (xpto.txt) as attachment in RAW mode and the email body having images as well

SMTP Host: smtp.gmail.com
SMTP Port: 587
From: email@gmail.com (this email must be the same one set in the account specified in this component)
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: enabled
Is Over TLS: enabled
Attachment As Raw: enabled
Attachments:

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

The result will be:

{
    "from": "email@gmail.com",
    "to": "some_other_email@gmail.com,second_email@gmail.com",
    "cc":"",
    "bcc": "",
    "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 ...TRUNCATED",
    "charset": "UTF-8",
    "success": true,
    "attachments": [
        {"type": "INLINE", "attachment": "myImage.png" },
        {"type": "ATTACHMENT", "attachment": "xpto.txt" }
    ]
}

See how to pass values in a dynamic way using the connector:

In this example, we pass a variable indicating the emission of an invoice:

<!DOCTYPE html>
<html>
<head>
  </head>
<body>
 
Good afternoon, <br/>
Below is the invoice <a href='${NF}'>(Click here)</a> referring to the monthly license fee for the platform – due for <b> ${M_VENC}</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>

Notice that the connector allows the use of Double Braces:

JSON Data

{
    "remetente": "digibee@gmail.com",
    "destinatario" : "digi@gmail.com",
    "destinatario_cc" : "digi1@gmail.com",
    "destinatario_bcc" : "digi2@gmail.com",
    "port" : "587",
    "host": "smtp.gmail.com",
    "NF": "98787979789",
    "M_VENC" : "13/01/2023"
}

Technology

We use Freemarker to make our conversions and transformations in the email body template. Read the Freemarker external documentation to know how to use it.

PreviousWeb protocols NextEmail V1 (Deprecated)

Last updated 11 months ago