FastComments.com

Para ajudar a oferecer uma experiência mais coesa para sua base de usuários, a FastComments fornece uma solução de personalização de e-mails para que os e-mails enviados aos seus clientes, pela FastComments, possam corresponder à sua identidade visual.

Nesta documentação, cobriremos os recursos desta solução, a linguagem de templates, localização, e mais.

Linguagem de Template Internal Link

FastComments Email Templates usa a linguagem de template EJS.

A sintaxe de exemplo é <%= object.someValue %> para imprimir variáveis, e declarações condicionais podem ser feitas assim:

<% if (some_condition) { %>
    <div>Some content.</div>
<% } else { %>
    <div>Some other content.</div>
<% } %>

Renderizar HTML bruto, como para o conteúdo do comentário, é feito assim: <%- comment.commentHTML %>. Observe o - em vez de =.

Consulte o link acima para mais documentação sobre a sintaxe.

Localização e Texto Personalizado Internal Link

FastComments é uma plataforma localizada. Todos os nossos widgets, e-mails e notificações são localizados.

Localizado significa que mostramos um idioma e uma formatação diferentes, com base na localização do usuário e no idioma preferido. Determinamos isso com base nas informações que o navegador do usuário nos fornece.

Podemos personalizar o texto no e-mail acessando a aba Translations, selecionando um Locale e editando o texto. O texto que é alterado em relação ao padrão é destacado na UI. Você pode alternar entre locales e salvar ao final, sem perder as alterações.

Texto localizado é acessado através do objeto TEXT, por exemplo: <%= TEXT.INTRO %>.

Nota sobre SSO

Para integrações SSO, se locale não for especificado, ele será atualizado sempre que o usuário acessar o widget de comentários com um locale diferente. Isso significa que a preferência de idioma deles é atualizada automaticamente, e futuros e-mails serão enviados nesse locale.

Isso também pode ser definido manualmente fornecendo locale no payload SSO.

Modelos por Domínio Internal Link

Os modelos podem ser configurados como globais - em todo o seu tenant para esse tipo de modelo, ou por domínio. Na aba Settings, selecione o domínio desejado.

Observe que, se você configurar múltiplos modelos para o mesmo domínio, apenas o primeiro será usado em tempo de execução. A lista de modelos alertará você quando essa situação ocorrer.

Dados e Variáveis Internal Link

Cada modelo funciona dentro de um contexto diferente, o que significa que dados diferentes estão disponíveis.

Uma maneira rápida de ver quais dados estão disponíveis é verificar os dados de teste fornecidos para o modelo. Ao editar um modelo, clique na aba Test Data para ver uma estrutura JSON.

Também podemos personalizar os dados de teste nesta área, para ver como nosso modelo fica em diferentes situações. Os dados de teste podem ser redefinidos para o padrão com o botão Reset.

Falhas de Renderização Internal Link

Como os templates de e-mail suportam variáveis, e lógica, é possível criar templates que falhem ao renderizar, ou às vezes não sejam renderizados.

Isto pode ser muito frustrante de diagnosticar e depurar, especialmente se for um problema intermitente, ou se ocorrer apenas quando os dados estão de uma certa forma.

Para ajudar, FastComments Email Templates tem alguns recursos:

  1. Se o template falhar ao pré-visualizar, ele não pode ser salvo. Uma mensagem de erro será exibida.
  2. Falhas de renderização de templates são rastreadas e reportadas na UI de administração.

O segundo item está descrevendo falhas de renderização que acontecem em produção. Ou seja, você cria um template que pré-visualiza corretamente - mas depois falha por algum motivo. Por exemplo, se tivermos isto em nosso template:

<% if (comment.commenterEmail.includes('test') { %>

Isto pode falhar às vezes se tivermos comentários anônimos ativados, já que o e-mail nem sempre estará disponível. Então como descobrimos isso?

A resposta é que os erros são exibidos em dois lugares. Primeiro, a própria lista de templates mostra uma contagem de erros de renderização com cada template.

Então, ao visualizar um template, podemos ver uma contagem, por erro, do número de vezes que o template falhou ao renderizar.

Um botão de reset está localizado ao lado de cada erro, e sua contagem, para que possamos zerar o contador apos termos resolvido um problema.

Aplicando Alterações Internal Link


Criar e editar modelos de e-mail é imediato. Isso significa, no momento em que você clicar no botão Save, a plataforma começará a usar a versão mais recente desse e-mail.