Configuração do Template de E-mail

Os templates de e-mail precisam estar com status ativo e em produção, para que ocorra o disparo automático e também possa ser realizado envio de e-mail teste.

Para realizar esta validação, basta clicar na pasta: Configs >> emails.json e verificar se o e-mail desejado possui as tags production e active, conforme abaixo:

TagOperaçãoDescrição
productiontrueO envio dos e-mails será realizado pelo Storefront e-mail.
productionfalseUtilizará os dados do template do SE.
activetrueO template de e-mail será enviado.
activefalseCaso production = true, esse tipo de e-mail não será enviado pelo Storefront e-mail.

Identificando o arquivo que corresponde a um determinado template

Para identificar qual arquivo (HTML) irá corresponder a qual template, basta acessar a pasta: Configs >> emails.json, que será apresentado os tipos de emails e o arquivo de cada um.

🚧

O arquivo emails.json apresenta os caminhos dos arquivos de template HTML localizados dentro da pasta Emails. Esses nomes podem ser alterados, desde que o arquivos também sejam renomeados.

O type não deve ser alterado.

No editor HTML é possível buscar um determinado template, basta acessar com Ctrl +F:

Acessando os templates através de uma branch

Para acessar os templates, basta clicar no botão Editar de uma branch e em seguida na pasta Emails:

Dentro da pasta Emails será apresentado as pastas Orders, Pedidos, Subscriptions e demais templates:

Cada pasta possui os templates de e-mails para que sejam customizados/alterados:

  • Pasta Orders: e-mails transacionais de pedido
  • Pasta Produtos: e-mails relacionado a produto

  • Pasta Subscriptions: e-mails relacionado a assinatura

  • Demais Templates: e-mails comportamentais

Editando um template de e-mail

Ao localizar o template de e-mail para edição, basta clicar sobre o mesmo para que seja aberto o editor código.

Ao realizar uma edição, os botões Validar Sintaxe e Salvar serão habilitados para que os mesmos possam ser executados.

É possível visualizar vários templates, abrindo em várias abas, conforme abaixo:

  • Botão Validar sintaxe:

O botão Validar sintaxe fará uma validação no html do template e caso esteja tudo correto, será apresentada a mensagem: Sintaxe ok.

Caso seja feita a validação de sintaxe e possua algum erro no html, será apresentada a mensagem: Erro de sintaxe, verifique o arquivo, e o local que se encontra o erro.

Ao realizar as customizações/alterações, basta clicar no botão Salvar.

Dentro dos templates de e-mails, possui uma aba com os campos disponíveis para o determinado template, ou seja, os campos que podem ser inseridos no template em questão.

Lembrando que cada template possui seus campos específicos.

A edição dos templates também possui um índice do arquivo, que permite o clique direcionando para o bloco em questão:

Visualizando os campos para o Template

Ao clicar na seta, será apresentado os campos/tags que poderão ser inseridas no template.

Preview do e-mail

Ao realizar as alterações você poderá pré-visualizar o template antes mesmo de salvar. Basta clicar no ícone com três pontinhos no template do e-mail ao lado do botão salvar que será apresentada a opção:

Ao clicar na opção Pré-visualizar será aberta uma nova janela com o template, apresentando as alterações realizadas:

Histórico de Alterações do Template

Todas as alterações realizadas no template serão apresentadas em uma tela. Para acessar basta clicar no ícone com três pontinhos ao lado do botão Salvar que será apresentada a opção:

Ao clicar na opção Visualizar na tela do histórico de alterações serão apresentadas as alterações no HTML, mostrando um comparativo do antes e depois das alterações.

Envio de E-mail Teste

Poderá realizar o envio do e-mail teste para verificar se as alterações realizadas no template estão conforme esperado.

Para realizar o envio de e-mail teste basta localizar o template desejado dentro da branch e clicar no ícone com três pontinhos ao lado do botão Salvar que será apresentada a opção:

Ao clicar na opção Enviar e-mail teste será apresentada uma tela para que possa ser inserido o e-mail para envio e o JSON Data do e-mail. Esse Json contém dados referentes ao último pedido realizado na loja e nele poderão ser editados os valores dos campos, caso houver necessidade. Apenas lembrar que não existe a possibilidade de salvar a alteração realizada:

Após inserção do e-mail e edição no JSON Data, basta clicar no botão Enviar e-mail que será apresentada a mensagem: E-mail teste enviado.

Após isso, basta verificar na caixa de e-mail o envio, conforme abaixo: