Email V2

Saiba mais sobre o conector Email V2 e como usá-lo na Digibee Integration Platform.

O conector Email V2 permite o envio de e-mails simples em formato HTML, com ou sem anexos.

Parâmetros

Configure o conector utilizando os parâmetros abaixo. Os campos que suportam expressões Double Braces estão marcados na coluna Suporta DB.

General

Parâmetro	Descrição	Tipo de dado	Suporta DB	Valor padrão	Visível quando
Alias	Nome (alias) para a saída deste conector, permitindo referenciá-la posteriormente no fluxo usando expressões Double Braces.	String	✅	email-v2-1	—
Account Type	Tipo de conta usada para autenticação. Suportados: Azure Key e Basic.	String	❌	Basic	—
Use Dynamic Account	Se habilitado, o conector usa a conta de forma dinâmica via o conector Store Account; caso contrário, usa a conta estática configurada em Contas na Plataforma.	Boolean	❌	false	—
Scoped	Se habilitado, isola a conta armazenada de outros subprocessos. Não é suportado para contas usadas em headers ou body. Para saber mais, consulte a documentação de Dynamic Accounts.	Boolean	❌	false	Use Dynamic Account está habilitado
Account Name	Nome da conta definida no conector Store Account.	String	✅	N/A	Use Dynamic Account está habilitado
Account	Conta usada para autenticar com o servidor de e-mail. Obrigatória caso o serviço exija autenticação. Deve ser do tipo de conta Azure Key ou Basic, configurada em Contas na Plataforma.	String	❌	N/A	Use Dynamic Account está desabilitado
SMTP Host	Host do servidor SMTP. Exemplo: smtp.gmail.com	String	✅	smtp.gmail.com	—
SMTP Port	Porta do servidor SMTP. Comumente 587, mas pode variar.	Integer	✅	587	—
From	Endereço de e-mail do remetente.	String	✅	N/A	—
To	Endereço(s) de e-mail do(s) destinatário(s), separados por vírgulas.	String	✅	N/A	—
CC	Destinatário(s) em cópia (CC), separados por vírgulas.	String	✅	N/A	—
BCC	Destinatário(s) em cópia oculta (BCC), separados por vírgulas.	String	✅	N/A	—
Reply To	Endereço para o qual as respostas a este e-mail são enviadas, em vez do endereço do remetente informado em From. Aceita um único endereço ou uma lista separada por vírgulas. Este parâmetro é opcional.	String	✅	N/A	—
Subject	Assunto do email.	String	✅	N/A	—
Charset	Conjunto de caracteres do corpo do email.	String		UTF-8	—
Content	Corpo do email. Suporta templates Freemarker para HTML dinâmico.	String	✅	N/A	—
Custom Attachments Specification	Habilita a entrada de anexos em formato bruto e oculta o campo de anexos baseado em formulário.	Boolean	❌	false	—
Attachments	Anexos do email. Especificados via formulário ou array bruto.	Array of objects	❌	N/A	Custom Attachments Specification está habilitado
Authenticated	Habilite caso seja necessária autenticação SMTP.	Boolean	❌	true	—
Is Over TLS	Habilite para enviar a mensagem via TLS.	Boolean	❌	true	—
Is Over SSL	Habilite para enviar a mensagem via SSL.	Boolean	❌	false	Is Over TLS está desabilitado
Socket Port	Obrigatório caso o SSL esteja habilitado. Especifica a porta utilizada.	Integer	✅	N/A	Is Over SSL está habilitado
Force TLSv1.2	Força o uso de TLS 1.2 para conexões seguras com o servidor de e-mail.	Boolean	❌	false	—
Fail On Error	Se habilitado, interrompe a execução do pipeline quando ocorre um erro. Se desabilitado, a execução prossegue, mas a propriedade "success" será definida como false.	Boolean	❌	false	—

Para incorporar imagens no corpo do e-mail, use o prefixo cid: no parâmetro Attachments, seguido do nome da imagem. Exemplo: <img src="cid:image.png" />

Documentation

Parâmetro	Descrição	Tipo de dado	Suporta DB	Valor padrão
Documentation	Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.	String	❌	N/A

Fluxo de mensagens

Entrada

Não é necessária nenhuma mensagem de entrada específica, a menos que alguma expressão Double Braces seja usada em um dos campos.

Saída

O conector retorna um objeto JSON como este:

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

Explicação dos campos:

• from: Email do remetente

• to: Destinatários

• cc: Destinatários em cópia

• bcc: Destinatários em cópia oculta

• subject: Assunto do email

• content: Corpo do email (será truncado se exceder 256 caracteres)

• charset: Codificação de caracteres utilizada

• success: Indica se o envio da mensagem foi bem-sucedido

• attachments: Lista de anexos

Os arquivos são manipulados de forma segura em um diretório temporário exclusivo do pipeline.

Saiba mais sobre o processamento de mensagens na Digibee Integration Platform.

Email V2 em ação

Autenticação

O conector Email V2 suporta os seguintes métodos de autenticação:

Basic

• Use uma conta do tipo Basic, onde o username é o e-mail do remetente e a password é a senha correspondente.

OAuth 2

Atualmente compatível apenas com contas de e-mail Microsoft (Outlook).

Para configurar:

• Preencha o campo From com o endereço de e-mail do remetente.

• Selecione uma Azure Key com as credenciais necessárias.

Internamente, o conector utiliza client-id, client-secret e tenant-id para gerar um token, que é usado junto ao email do remetente para autenticar com o servidor SMTP.

Exemplo: Email com anexos e imagem embutida (modo RAW)

Configuração:

• SMTP Host: smtp.gmail.com

• SMTP Port: 587

• From: [e-mail] (mesmo email configurado no parâmetro Account)

• To: [e-mail], [e-mail]

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

Saída:

{
    "from": "[e-mail]",
    "to": "[e-mail],[e-mail]",
    "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" }
    ]
}

Exemplo dinâmico com expressões Double Braces

Você pode usar expressões Double Braces para inserir variáveis dinamicamente na configuração do conector.

Neste exemplo, o componente JSON Generator (Mock) foi configurado com os seguintes dados:

JSON de entrada:

{
    "remetente": "[e-mail]",
    "destinatario" : "[e-mail]",
    "destinatario_cc" : "[e-mail]",
    "destinatario_bcc" : "[e-mail]",
    "port" : "587",
    "host": "smtp.gmail.com",
    "NF": "98787979789",
    "M_VENC" : "13/01/2023"
}

Em seguida, o conector Email V2 foi configurado da seguinte forma:

• SMTP Host: {{ message.host }}

• SMTP Port: {{ message.port }}

• From: {{ message.remetente }}

• To: {{ message.destinatario }}

• CC: {{ message.destinatario_cc }}

• BCC: {{ message.destinatario_bcc }}

• Subject: {{ CONCAT("Nota fiscal ", 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>

Boa tarde, <br/>
Segue a nota fiscal <a href='${NF}'>(Clique aqui)</a> referente à mensalidade da plataforma – com vencimento em <b>${M_VENC}</b>. <br/>
O pagamento será via <b>transferência bancária</b>, conforme dados informados na nota fiscal. <br/><br/>

Por favor, confirme o recebimento. <br/>
Em caso de dúvidas, estamos à disposição. <br/><br/>

<br/>
<br/>
Att.,<br/>
Relacionamento com o cliente

</body>
</html>

Tecnologia

O conector utiliza Freemarker para geração de conteúdo dinâmico.