FastComments.com


Чтобы обеспечить более целостный опыт для вашей базы пользователей, FastComments предоставляет решение для настройки электронной почты, чтобы электронные письма, отправляемые вашим клиентам от FastComments, могли соответствовать вашему бренду.

В этой документации мы рассмотрим возможности этого решения, язык шаблонов, локализацию, и многое другое.


Язык шаблонов Internal Link


Шаблоны електронної пошти FastComments використовують мова шаблонів EJS.

Приклад синтаксису: <%= object.someValue %> для виведення змінних, а умовні оператори можна зробити так:

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

Виведення необробленого HTML, наприклад вмісту коментаря, здійснюється так: <%- comment.commentHTML %>. Зверніть увагу на - замість =.

Зверніться до наведеного вище посилання для подальшої документації по синтаксису.


Локализация и пользовательский текст Internal Link

FastComments — это локализованная платформа. Все наши виджеты, электронные письма и уведомления локализованы.

Локализация означает, что мы показываем другой язык и форматирование в зависимости от местоположения пользователя и предпочтительного языка. Мы определяем это на основе информации, которую предоставляет браузер пользователя.

Мы можем настроить текст в письме, перейдя на вкладку Translations, выбрав Locale и отредактировав текст. Текст, изменённый относительно значения по умолчанию, выделяется в интерфейсе. Вы можете переключаться между локалями и сохранить в конце, не потеряв изменения.

К локализованному тексту можно получить доступ через объект TEXT, например: <%= TEXT.INTRO %>.

Примечание SSO

Для интеграций SSO, если locale не указан, он будет обновляться каждый раз, когда пользователь доступается к виджету комментариев с другой локалью. Это означает, что его языковые предпочтения автоматически обновляются, и будущие письма будут отправляться на этой локали.

Это также можно задать вручную, передав locale в полезной нагрузке SSO.

Шаблоны по доменам Internal Link

Шаблоны можно настроить как глобальными - для всего вашего тенанта для этого типа шаблона, или для отдельного домена. На вкладке Settings выберите нужный домен.

Обратите внимание, что если вы настроите несколько шаблонов для одного и того же домена, во время выполнения будет выбран только первый. Список шаблонов предупредит вас, когда возникнет такая ситуация.

Данные и переменные Internal Link


Каждый шаблон функционирует в своём контексте, поэтому доступны разные данные.

Быстрый способ увидеть, какие данные доступны — посмотреть тестовые данные, предоставленные для шаблона. При редактировании шаблона нажмите вкладку Test Data, чтобы увидеть структуру JSON.

Также мы можем настроить тестовые данные в этой области, чтобы посмотреть, как шаблон выглядит в разных ситуациях. Тестовые данные можно сбросить до значения по умолчанию с помощью кнопки Reset.


Ошибки рендеринга Internal Link


Поскольку email-шаблоны поддерживают переменные и логику, возможно создать шаблоны, которые не удаётся отрендерить или которые иногда дают сбой при рендеринге.

Это может быть очень тяжело диагностировать и отлаживать, особенно если это периодическая проблема или если она возникает только тогда, когда данные выглядят определённым образом.

Чтобы помочь, FastComments Email Templates имеет несколько возможностей:

  1. Если шаблон не удаётся предварительно просмотреть, его нельзя сохранить. Появится сообщение об ошибке.
  2. Сбои рендеринга шаблонов отслеживаются и отображаются в административном интерфейсе.

Второй пункт описывает сбои рендеринга, которые происходят в продакшене. То есть вы создаёте шаблон, который в предпросмотре выглядит нормально - но позже по какой‑то причине начинает давать сбой. Например, если в нашем шаблоне есть следующее:

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

Это иногда может приводить к ошибке, если у нас включено анонимное комментирование, поскольку email будет не всегда доступен. Так как же об этом узнать?

Ответ в том, что об ошибках сообщается в двух местах. Сначала сам список шаблонов показывает счётчик ошибок рендеринга для каждого шаблона.

Затем, при просмотре шаблона, мы можем увидеть для каждой ошибки количество раз, когда шаблон не удалось отрендерить.

Рядом с каждой ошибкой и её счётчиком находится кнопка сброса, чтобы мы могли обнулить счётчик после того, как решили проблему.


Применение изменений Internal Link

Создание и редактирование шаблонов электронной почты происходит мгновенно. Это означает, что в тот же момент, когда вы нажимаете кнопку Save, платформа начнёт использовать последнюю версию этого письма.