Templates de E-mail
Pré-requisitos de acesso
- Permissão (módulo): acesso liberado pelo guard administrativo da rota (
admin). Não há módulo dinâmico específico para esta tela. - Licença/Feature: Nenhuma.
- Contêiner do menu: GERAL → grupo Comunicação (ícone
campaign) → Templates de E-mail.
O que é / quando usar
Catálogo dos templates transacionais da plataforma — o conteúdo específico de cada e-mail do sistema (boas-vindas, recuperação de senha, confirmações, códigos, etc.). Cada template tem versão em Português e Inglês, podendo também carregar um texto de SMS equivalente. Use para editar o texto/HTML que o sistema dispara automaticamente em cada evento, sem mexer no código.
Pré-condições
- Permissão: item sob o guard
adminda rota. Permissão no Axia é dupla (enum CPM + módulo dinâmico no DB); aqui o gate é o guard de rota. - Licença/Feature: nenhuma.
- Dependências de outras telas: a moldura (cabeçalho/rodapé/marca) ao redor desse conteúdo vem do Template Master.
Passo a passo
- Acesse o menu Comunicação → Templates de E-mail.
- A tela lista os templates existentes; use a busca para filtrar por
idou assunto (pt/en). - Clique em Visualizar para abrir a prévia direta, ou em Editar para abrir o editor.
- No editor, ajuste assunto/HTML/SMS por idioma usando as abas.
- Pré-visualize e Salve.
Campos
Listagem
| Coluna | O que mostra | Origem do dado |
|---|---|---|
Id (id) | Identificador do template (a chave que o sistema usa para disparar) | email_template.id |
Assunto (subject) | Assunto em Português | subject |
Tem Inglês (hasEnglish) | Se há versão em inglês preenchida | derivado de subject_en/htmlData_en |
Tem SMS (hasSms) | Se há texto de SMS associado | derivado de sms/sms_en |
| Ações | Visualizar / Editar | — |
Editor (modal)
| Campo | O que é | Obrigatório? | Efeito no sistema/backend |
|---|---|---|---|
Assunto (subject / subject_en) | Assunto do e-mail por idioma | Sim (pelo menos pt) | Gravado no template; usado como subject no disparo automático. |
HTML (htmlData / htmlData_en) | Corpo HTML do e-mail por idioma | Sim | Conteúdo renderizado dentro da moldura do Template Master. |
Corpo texto (body) | Versão texto plano (fallback) | Não | Alternativa textual quando aplicável. |
SMS (sms / sms_en) | Texto curto para o canal SMS do mesmo evento | Não | Permite que o mesmo evento dispare também um SMS. |
De / Para (from / to) | Metadados de remetente/destinatário do template | Não | Campos auxiliares do template. |
Placeholders do editor
A prévia substitui marcadores pelo dado real (usuário logado):
| Placeholder | Substituído por |
|---|---|
@name@ | Nome do usuário |
@email@ | E-mail do usuário |
@date@ | Data atual (pt-BR) |
@link@ | Origem/URL base da plataforma |
@code@ | Código numérico de 6 dígitos (exemplo, p/ e-mails de verificação) |
Ações e modais
- Visualizar: abre o editor em modo somente leitura com a prévia aberta diretamente (
openPreviewDirectly). Se o template não tiver conteúdo, avisa que não há o que exibir. - Editar: abre o editor com abas; ao Salvar, envia o template ao backend (
updateEmailTemplate). Em sucesso, fecha e recarrega a lista; em erro, mantém aberto com aviso. - Pré-visualizar (pt / en): monta o HTML do idioma com os placeholders resolvidos e renderiza num
iframe. Avisa se o idioma escolhido estiver vazio. - Buscar: filtra a tabela por
id,subjectousubject_en.
Regras de negócio / cuidados
Atenção
- O
iddo template é a chave de disparo usada pelo sistema. Não invente/renomeie ids: altere conteúdo, não a chave, sob risco de o evento parar de encontrar o template. - Mantenha pt e en coerentes; um idioma vazio degrada a experiência de quem usa aquele locale.
- HTML de e-mail é restritivo (tabelas + estilo inline). Valide na prévia antes de salvar.
- Os placeholders na prévia usam dados do operador logado (apenas para visualização); no envio real, são preenchidos com os dados do destinatário/evento.
- Renderização cross-provider: conteúdo enviado via
SimpleEmailService(bodyData+htmlData). HTML quebrado pode virar texto plano em Mailgun/Brevo/SendGrid; o SES mascara.