O Portal de Documentação foi aprimorado! Explore as abas e compartilhe sua opinião.
Enviar feedback.
Agendar demonstração

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

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Aba General

Parâmetro
Descrição
Valor padrão
Tipo de dado

Account Type

Tipo de conta usada para autenticação. Suportados: Azure Key e Basic.

Basic

String

Account

Conta usada para autenticar no servidor de email. Obrigatória se o serviço exigir autenticação. Suportados: Azure Key e Basic.

N/A

String

SMTP Host (DB)

Host do servidor SMTP. Exemplo: smtp.gmail.com

smtp.gmail.com

String

SMTP Port (DB)

Porta do servidor SMTP. Geralmente é a 587, mas pode variar.

587

Integer

From (DB)

Endereço de email do remetente.

N/A

String

To (DB)

Endereço(s) de email do(s) destinatário(s), separados por vírgula.

N/A

String

CC (DB)

Endereço(s) de email em cópia, separados por vírgula.

N/A

String

BCC (DB)

Endereço(s) de email em cópia oculta, separados por vírgula.

N/A

String

Subject (DB)

Assunto do email.

N/A

String

Charset

Conjunto de caracteres usado no corpo do email.

UTF-8

String

Content (DB)

Corpo do email. Suporta templates Freemarker para HTML dinâmico.

N/A

String

Custom Attachments Specification

Ativa o envio de anexos via array (modo RAW) e oculta o campo de anexo via formulário.

False

Booleano

Attachments

Anexos do email. Especificados via formulário ou array.

N/A

Array of objects

Authenticated

Ative se for necessário autenticar no SMTP.

True

Booleano

Is Over TLS

Ative para enviar a mensagem via TLS.

True

Booleano

Is Over SSL

Ative para enviar a mensagem via SSL. Disponível apenas quando Is Over TLS está desabilitado.

False

Booleano

Socket Port (DB)

Obrigatório se SSL estiver ativado. Especifica a porta usada. Disponível apenas quando Is Over SSL está habilitado.

N/A

Integer

Force TLSv1.2

Força o uso de TLS 1.2 para conexões seguras com o servidor de e-mail. Disponível apenas quando Is Over SSL está habilitado.

False

Booleano

Fail On Error

Se ativado, interrompe a execução do pipeline ao ocorrer um erro. Se desativado, a execução continua, mas a propriedade "success" será definida como false.

False

Booleano

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" />

Aba Documentação

Parâmetro
Descrição
Valor padrão
Tipo de dado

Documentation

Campo opcional para descrever a configuração do conector e quaisquer regras de negócio relevantes.

N/A

String

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": "[email protected]",
  "to": "[email protected],[email protected]",
  "cc": "[email protected],[email protected]",
  "bcc": "[email protected],[email protected]",
  "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:

<!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": "[email protected]",
    "to": "[email protected],[email protected]",
    "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": "[email protected]",
    "destinatario" : "[email protected]",
    "destinatario_cc" : "[email protected]",
    "destinatario_bcc" : "[email protected]",
    "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.

AnteriorWeb protocolsPróximoEmail V1 (Descontinuado)

Atualizado

Isto foi útil?