1. Visão Geral
O componente Email (email) envia e-mails via SMTP a partir do fluxo. Suporta e-mails em texto puro ou HTML, com destinatários em cópia (CC) e cópia oculta (BCC).
Use quando o fluxo precisa notificar alguém por e-mail (confirmação de pedido, alerta, relatório, etc.). Só funciona como ação de saída — não como gatilho de entrada (não recebe e-mails).
2. Pré-requisitos
- Um servidor SMTP acessível (host e porta) para envio.
- Usuário e senha de autenticação SMTP, se o servidor exigir.
3. Autenticação e Conexão
| Campo | Obrigatório | Tipo | Descrição | Exemplo |
|---|---|---|---|---|
host | Sim, na prática | Texto | Endereço do servidor SMTP. | "smtp.exemplo.com" |
port | Não | Texto | Porta do servidor SMTP. Valor padrão: "587". | "587" |
protocol | Não | Texto | Protocolo de envio. Valor padrão: "SMTP". | "SMTP" |
username | Não | Texto | Usuário para autenticação SMTP. | "notificacoes@exemplo.com" |
password | Não | Texto | Senha do usuário SMTP. | "minhasenha" |
useStartTls | Não | Texto ("true"/"false") | Habilita STARTTLS na conexão. Valor padrão: "true". | "true" |
A autenticação SMTP é usada automaticamente sempre que username e password estiverem preenchidos.
4. Configuração / Operações Suportadas
O componente tem uma única operação: enviar um e-mail.
| Campo | Obrigatório | Tipo | Descrição | Exemplo |
|---|---|---|---|---|
from | Sim | Texto | Remetente do e-mail. | "notificacoes@exemplo.com" |
to | Sim | Texto | Destinatário(s) do e-mail. | "cliente@exemplo.com" |
subject | Sim | Texto | Assunto do e-mail. | "Seu pedido foi confirmado" |
isTextMessage | Não | Texto ("true"/"false") | Se true, o corpo é enviado como texto puro (usando textMessage). Se false (padrão), como HTML (usando htmlMessage). | "true" |
textMessage | Sim, se isTextMessage for true | Texto | Corpo do e-mail em texto puro. | "Seu pedido 981 foi confirmado." |
htmlMessage | Não | Texto (HTML) | Corpo do e-mail em HTML. | "<p>Seu pedido foi confirmado.</p>" |
cc | Não | Texto | Destinatários em cópia. | "gerente@exemplo.com" |
bcc | Não | Texto | Destinatários em cópia oculta. | "auditoria@exemplo.com" |
5. Exemplos Práticos
Exemplo simples: enviar um e-mail de confirmação de pedido em texto puro.
Entrada:
{
"pedidoId": 981,
"cliente": { "email": "maria@exemplo.com" }
}
Configuração do componente:
{
"componentName": "email",
"configurations": {
"from": "notificacoes@exemplo.com",
"to": "{$.body.cliente.email}",
"subject": "Pedido confirmado",
"isTextMessage": "true",
"textMessage": "Seu pedido {$.body.pedidoId} foi confirmado."
}
}
Resposta:
{
"success": true,
"status": "Message sent",
"from": "notificacoes@exemplo.com",
"to": ["maria@exemplo.com"],
"subject": "Pedido confirmado",
"messageType": "text/plain"
}
Exemplo avançado: enviar um e-mail em HTML, com cópia para o gerente e cópia oculta para auditoria.
Configuração do componente:
{
"componentName": "email",
"configurations": {
"from": "notificacoes@exemplo.com",
"to": "{$.body.cliente.email}",
"cc": "gerente@exemplo.com",
"bcc": "auditoria@exemplo.com",
"subject": "Pedido confirmado",
"htmlMessage": "<h1>Pedido confirmado</h1><p>Seu pedido {$.body.pedidoId} foi confirmado.</p>"
}
}
Resposta:
{
"success": true,
"status": "Message sent",
"from": "notificacoes@exemplo.com",
"to": ["maria@exemplo.com"],
"subject": "Pedido confirmado",
"messageType": "text/html"
}
6. Erros Comuns e Troubleshooting
| Erro / Sintoma | Causa provável | Como resolver |
|---|---|---|
| "Connector IN Not supported for email" | Tentativa de usar o Email como gatilho de entrada. | Usar o componente apenas como ação de saída. |
| "From parameter is empty." | O campo from não foi preenchido. | Preencher from com o remetente. |
| "To parameter is empty." | O campo to não foi preenchido. | Preencher to com o(s) destinatário(s). |
| "Subject parameter is empty." | O campo subject não foi preenchido. | Preencher subject. |
| "Text Message parameter is empty." | isTextMessage está ativado, mas textMessage não foi preenchido. | Preencher textMessage ou desativar isTextMessage para usar htmlMessage. |
| E-mail não chega ao destinatário | Configuração incorreta de host/port/autenticação SMTP, ou bloqueio do servidor de destino. | Confirmar as credenciais e configuração do servidor SMTP usado. |