emails.json

Este arquivo, denominado emails.json, é utilizado para vincular os tipos de emails disponíveis aos arquivos HTML correspondentes que são encontrados por padrão na raiz pasta "Emails/." Esta documentação descreverá os campos e a estrutura do arquivo JSON para garantir uma compreensão clara e eficaz.

Estrutura JSON

O arquivo emails.json é uma matriz de objetos JSON, onde cada objeto representa um tipo de email e contém os seguintes campos:

• type (Tipo): Este campo descreve o tipo de email. Deve ser uma string que fornece uma identificação fixa e única para o tipo de email da plataforma.
• path (Caminho): O campo "path" especifica o nome do arquivo HTML correspondente a esse tipo de email. O arquivo HTML deve estar localizado dentro da pasta "Emails/" e conter o conteúdo do email. O valor deste campo é uma string que representa o nome do arquivo.
• production (Produção): O campo "production" é um valor booleano que indica se esse tipo de email está em produção ou não. Se for definido como "true," o email está ativo e será enviado em situações de produção. Se for definido como "false," o email não será enviado em produção. Isso é útil para testar ou desativar tipos de emails temporariamente.
• active (Ativo): O campo "active" também é um valor booleano que indica se esse tipo de email está ativo ou não. Se for definido como "true," o tipo de email está ativo e pode ser usado. Se for definido como "false," o tipo de email está inativo e não deve ser usado. Isso permite uma fácil ativação ou desativação de tipos de emails sem remover suas definições.

🚧

Atenção aos tipos de email

Cada tipo é único e específico para identificação na renderização e envio dos emails. Caso seja necessário desativar o envio, evite remover o objeto do arquivo JSON e dê preferência por alterar os campos production e/ou active.

Exemplo

Aqui está um exemplo parcial do conteúdo do arquivo "emails.json":

JSON

[
  {
    "type": "AgradecimentoNews",
    "path": "news_thank.html",
    "production": true,
    "active": true
  },
  {
    "type": "AssinaturaEntregue",
    "path": "Subscriptions/subscription_delivered.html",
    "production": true,
    "active": true
  },
  ...
]

Neste exemplo, dois tipos de emails, "AgradecimentoNews" e "AssinaturaEntregue," estão definidos com seus respectivos arquivos HTML vinculados e ativos para envio em produção.