Шаблоны уведомлений по электронной почте

Шаблоны уведомлений по электронной почте — это HTML-файлы с готовой разметкой, используемые для создания текста темы и основного содержания уведомления, которое система отправляет авторам и авторизованным читателям при различных событиях, описанных ниже. Как настроить шаблоны уведомлений по электронной почте, вы можете узнать здесь:  Настройка шаблонов уведомлений по электронной почте.

Файлы шаблонов уведомлений по электронной почте находятся в папке /Storage/Templates/Emails. Их имена выглядят следующим образом: CreateUserTemplate.ru-RU.html.

Список файлов шаблонов уведомлений по электронной почте

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

Файл шаблона уведомления по электронной почте
Описание
Плейсхолдеры для тега <head> (шапка) Плейсхолдеры для тега <body> (основной текст)
AiLimitsWarningTemplate.en-US.html
Отправляется администраторам, когда лимит доступных ИИ токенов меньше 30%, 10% и достигает 0%
{{PERCENT_LEFT}}
{{PERCENT_LEFT}}, {{AI_LIMITS_URL}}, {{USER_NOTIFICATION_SETTINGS_URL}}
ArticleAssignedToChangeTemplate.en-US.html
Отправляется при смене исполнителя одной страницы {{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{USER_PROFILE_URL}}
ArticleAssignedToChangeToSomeoneTemplate.en-US.html
Отправляется подписанным авторам при смене исполнителя
{{TOPIC_ID}}, {{TOPIC_ASSIGNED_TO_USER_PROFILE_NAME}}
{{TOPIC_ASSIGNED_TO_USER_PROFILE_HTML}}, {{TOPIC_URL}}, {{TOPIC_ID}}, {{TOPIC_TITLE}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{TOPIC_STATUS_COLOR}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{TODO_ITEMS_LIST}}, {{USER_NOTIFICATION_SETTINGS_URL}}
ArticleAssignedToMultiChangeTemplate.en-US.html Отправляется при смене исполнителя нескольких страниц
{{TOPIC_COUNT}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_COUNT}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{USER_PROFILE_URL}}
ArticleAssignedToMultiChangeToSomeoneTemplate.en-US.html
Отправляется подписанным авторам при смене исполнителя нескольких страниц
{{TOPIC_COUNT}}, {{TOPIC_ASSIGNED_TO_USER_PROFILE_NAME}}
{{TOPIC_COUNT}}, {{TOPIC_ASSIGNED_TO_USER_PROFILE_HTML}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
ArticleContentChangeExternalTemplate.en-US.html

Отправляется авторизованным читателям при изменении страницы или её заголовка
{{TOPIC_TITLE}}
{{TOPIC_URL}}, {{TOPIC_TITLE}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{VIEW_CHANGES_LINK_HTML}}, {{CHANGES_HTML}}, {{STOP_WATCHING_URL}}
ArticleContentChangeTemplate.en-US.html
Отправляется исполнителям и/или авторам подписанным на страницу при изменении страницы или её заголовка
{{TOPIC_TITLE}}
{{TOPIC_URL}}, {{TOPIC_TITLE}}, {{PROJECT_URL}},{{PROJECT_NAME}}, {{TOPIC_STATUS_COLOR}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{VIEW_CHANGES_LINK_HTML}}, {{CHANGES_HTML}}, {{TODO_ITEMS_LIST}}, {{USER_NOTIFICATION_SETTINGS_URL}}, {{PROJECT_OR_PUBLICATION}}
ArticleContentMultiChangeExternalTemplate.en-US.html
Отправляется авторизованным читателям, подписанным на обновления страниц, при изменении содержания или заголовка нескольких страниц одновременно

{{TOPIC_COUNT}}, {{UPDATED_TOPICS_HTML}}, {{PROJECT_URL}}, {{PROJECT_NAME}}
ArticleContentMultiChangeTemplate.en-US.html
Отправляется авторам, подписанным на обновления страниц, при изменении содержания или заголовка нескольких страниц одновременно
{{TOPIC_COUNT}}
{{TOPIC_COUNT}}, {{UPDATED_TOPICS_HTML}}, {{PROJECT_OR_PUBLICATION}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{USER_NOTIFICATION_SETTINGS_URL}}
ArticleReviewCommentAddTemplate.en-US.html Отправляется при добавлении на странице комментария рецензента {{TOPIC_ID}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleReviewCommentDeleteTemplate.en-US.html Отправляется при удалении комментария рецензента на странице
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleReviewCommentResolveTemplate.en-US.html Отправляется при решении комментария рецензента на странице
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{COMMENT_HOTSPOT}}, {{COMMENT_DETAILS}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{TOPIC_URL}}, {{USER_PROFILE_URL}}
ArticleStatusChangeTemplate.en-US.html Отправляется при смене статуса одной страницы
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{USER_PROFILE_URL}}
ArticleStatusMultiChangeTemplate.en-US.html Отправляется при смене статуса нескольких страниц
{{TOPIC_COUNT}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_COUNT}}, {{PROJECT_URL}}, {{PROJECT_NAME}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{USER_PROFILE_URL}}, {{TOPIC_STATUS_COLOR}}, {{TOPIC_STATUS}}
ArticleToDoItemAddTemplate.en-US.html
Отправляется при добавлении элемента списка задач для страницы
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ArticleToDoItemDeleteTemplate.en-US.html
Отправляется при удалении элемента списка задач для страницы
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ArticleToDoItemDoneTemplate.en-US.html
Отправляется, когда элемент списка задач для страницы помечается как "выполненный"
{{TOPIC_ID}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{TOPIC_TITLE}}, {{TOPIC_URL}}, {{TOPIC_STATUS}}, {{MODIFIED_BY_USER_PROFILE_URL}}, {{TODO_ITEMS_LIST}}, {{PROJECT_NAME}}, {{PROJECT_URL}}, {{TOPIC_STATUS_COLOR}}, {{ACTION}}, {{USER_PROFILE_URL}}
ChangePasswordTemplate.en-US.html Отправляется после смены пароля для страницы профиля
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{NEW_PASSWORD}}
CreateUserTemplate.en-US.html Отправляется при создании нового пользователя через API или интерфейс автора
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_LOGIN}}, {{PASSWORD}}
CustomDomainCertificateExpirationTemplate.en-US.html
Отправляется когда срок действия пользовательского сертификата истекает через 30, 7 и 1 день.
{{DAYS_UNTIL_EXPIRATION}}
{{DAYS_UNTIL_EXPIRATION}}, {{PORTAL_NAME}}, {{CUSTOM_DOMAIN_NAME}}, {{CERTIFICATE_EXPIRATION_DATE}}, {{DOMAIN_SETTINGS_URL}}, {{USER_NOTIFICATION_SETTINGS_URL}}
CustomDomainCertificateRenewalFailureTemplate.en-US.html
Отправляется при возникновении ошибки во время обновления сертификата Let's Encrypt.

{{PORTAL_NAME}}, {{CUSTOM_DOMAIN_NAME}}, {{DOMAIN_SETTINGS_URL}}
CustomDomainMappingFailureTemplate.en-US.html
Отправляется при возникновении ошибки во время настройки нового сертификата Let's Encrypt.

{{PORTAL_NAME}}, {{CUSTOM_DOMAIN_NAME}}, {{DOMAIN_SETTINGS_URL}}
CustomDomainSuccessfullyMappedTemplate.en-US.html
Отправляется после успешной настройки сертификата Let's Encrypt и сопоставления пользовательского доменного имени.

{{PORTAL_NAME}}, {{CUSTOM_DOMAIN_NAME}}
MentionTemplate.en-US.html
Отправляется при упоминании пользователя
{{MENTIONED_BY_USER_PROFILE_NAME}}
{{MENTIONED_BY_USER_PROFILE_HTML}}, {{TOPIC_URL}}, {{TOPIC_TITLE}}, {{PROJECT_URL}}, {{PROJECT_NAME}},{{TOPIC_STATUS_COLOR}}, {{TOPIC_STATUS}}, {{MENTION_DETAILS_HTML}}, {{VIEW_MENTION_LINK_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
ProjectArticlesUpdateExternalTemplate.en-US.html
Отправляется авторизованным читателям, подписанным на обновления страниц в публикации, при добавлении одной или нескольких страниц и/или изменении нескольких страниц
{{PROJECT_NAME}}
{{NEW_TOPICS_HTML}}, {{UPDATED_TOPICS_HTML}}, {{STOP_WATCHING_URL}}
ProjectArticlesUpdateTemplate.en-US.html
Отправляется авторам, подписанным на обновления страниц в публикации или проекте, при добавлении одной или нескольких страниц и/или изменении нескольких страниц
{{PROJECT_OR_PUBLICATION}}, {{PROJECT_NAME}}
{{PROJECT_OR_PUBLICATION}}, {{NEW_TOPICS_HTML}}, {{UPDATED_TOPICS_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}, {{STOP_WATCHING_URL}}, {{PROJECT_OR_PUBLICATION}}
OfficialMasterTemplate.en-US.html
Мастер-шаблон, который используется в качестве основы для всех остальных шаблонов.

{{CONTENT}}
ResetApiKeyTemplate.en-US.html Отправляется, когда автор сбрасывает ключ API на странице своего профиля
{{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{API_KEY}}
ResetPasswordConfirmTemplate.en-US.html Отправляется при сбросе пароля по запросу со страницы Забыли пароль {{USER_FIRST_NAME}} {{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{PASSWORD_RESET_URL}}
ResetPasswordTemplate.en-US.html Отправляется при сбросе пароля по запросу из профиля пользователя
{{USER_FIRST_NAME}}
{{SENT_FROM_URL}}, {{USER_FIRST_NAME}}, {{USER_LOGIN}}, {{NEW_PASSWORD}}
TransAssignedToChangeTemplate.en-US.html
Отправляется при смене исполнителя для переводного документа
{{TRANS_ID}}
{{USER_FIRST_NAME}}, {{TRANS_URL}}, {{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}}, {{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
TransAssignedToChangeToSomeoneTemplate.en-US.html
Отправляется авторам подписанным на страницу при смене исполнителя переводного документа
{{TRANS_ASSIGNED_TO_USER_PROFILE_NAME}},{{TRANS_ID}}
{{TRANS_ASSIGNED_TO_USER_PROFILE_NAME}}, {{TRANS_ID}},{{TRANS_ASSIGNED_TO_USER_PROFILE_HTML}}, {{TRANS_URL}},{{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}},{{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
TransContentChangeTemplate.en-US.html
Отправляется исполнителям или авторам, подписанным на страницу, при изменении содержания или заголовка переводного документа
{{TRANS_ID}}
{{TRANS_URL}}, {{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}}, {{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{VIEW_CHANGES_LINK_HTML}}, {{CHANGES_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}
TransStatusChangeTemplate.en-US.html
Отправляется при смене статуса переводного документа
{{TRANS_ID}}
{{USER_FIRST_NAME}}, {{TRANS_URL}}, {{TRANS_NAME}}, {{PROJECT_NAME_HTML}}, {{TRANS_STATUS_COLOR}}, {{TRANS_STATUS}}, {{MODIFIED_BY_USER_PROFILE_HTML}}, {{USER_NOTIFICATION_SETTINGS_URL}}

Если пользователь подписан на обновления для публикации/проекта, и поменялось содержание только одной страницы, то Авторам отправляется оповещение ArticleContentChangeTemplate.en-US.html, Читателям - оповещение ArticleContentChangeExternalTemplate.en-US.html

Если изменилось содержание нескольких страниц, то Авторам отправляется оповещение ProjectArticlesUpdateTemplate.en-US.html, Читателям - оповещение ProjectArticlesUpdateExternalTemplate.en-US.html

Список доступных плейсхолдеров

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

После обновления, выпущенного осенью 2023, плейсхолдер {{USER_FIRST_NAME}} больше не поддерживается. Он остаётся только для обеспечения совместимости с шаблонами, созданными в предыдущих версиях.
Плейсхолдер
Описание
{{ACTION}}

Описание выполняемого действия.

Например:
Когда рецензент добавляет комментарий (шаблон ArticleReviewCommentAdd), данный плейсхолдер будет заменен следующим текстом: К странице добавлен комментарий рецензента.

{{AI_LIMITS_URL}}
Ссылка на страницу Моя подписка.
{{API_KEY}} Сгенерированный ключ API.
{{CERTIFICATE_EXPIRATION_DATE}}
Дата истечения срока действия пользовательского сертификата.
{{CHANGES_HTML}}
Блок HTML, содержащий изменения между предыдущей и последней версиями страницы.
{{COMMENT_HOTSPOT}} Текстовое содержание комментария рецензента.
{{COMMENT_DETAILS}} Более подробная информация о комментарии рецензента, включая текстовое содержание комментария, ссылку на профиль пользователя, выполнившего данное действие, а также дату и время действия.
{{CONTENT}} Используется только в файле OfficialMasterTemplate.en-US.html и заменяется контентом отправленного уведомления.
{{CUSTOM_DOMAIN_NAME}}
Пользовательское доменное имя портала Документерры.
{{DAYS_UNTIL_EXPIRATION}}
Количество дней до истечения срока действия пользовательского сертификата.
{{DOMAIN_SETTINGS_URL}}
Ссылка на настройки пользовательского доменного имени.
{{MENTIONED_BY_USER_PROFILE_HTML}}
Ссылка на профиль пользователя, который сделал упоминание.
{{MENTIONED_BY_USER_PROFILE_NAME}}
Имя пользователя, который сделал упоминание. Может быть логином или логином и именем, если Имя, Фамилия и Отчество указаны в профиле пользователя.
{{MENTION_DETAILS_HTML}}
Дополнительная информация об упоминании. Для комментариев рецензента это комментарий, в котором было сделано упоминание.
{{MODIFIED_BY_USER_PROFILE_HTML}}
Ссылка на страницу профиля пользователя, внесшего изменения, с изображением аватара.
{{MODIFIED_BY_USER_PROFILE_URL}} Ссылка на страницу профиля пользователя, внесшего изменения.
{{NEW_PASSWORD}} Новый пароль для пользователя.
{{PASSWORD}} Пароль для созданного пользователя.
{{PASSWORD_RESET_URL}} Ссылка для сброса пароля.
{{PERCENT_LEFT}}
Процент доступных ИИ токенов на портале.
{{PORTAL_NAME}}
Имя вашего портала Документерры.
{{PROJECT_NAME}} Название проекта/публикации, в которую были внесены изменения.
{{PROJECT_NAME_HTML}} Название проекта/публикации, в котором были внесены изменения, в виде ссылки на проект/публикацию.
{{PROJECT_OR_PUBLICATION}}
Слово "Публикация" или "Проект" в зависимости от того, где было сделано изменение.
{{PROJECT_URL}} Ссылка на проект/публикацию, в которую были внесены изменения.
{{SENT_FROM_URL}} URL-адрес портала, с которого отправляется сообщение.
{{STOP_WATCHING_URL}}
Ссылка для отписки от обновлений страницы.
{{TODO_ITEMS_LIST}} Список задач для страницы, в которую были внесены изменения.
{{TOPIC_ASSIGNED_TO_USER_PROFILE_HTML}}
Ссылка на профиль нового исполнителя страницы.
{{TOPIC_ASSIGNED_TO_USER_PROFILE_NAME}}
Имя нового исполнителя страницы. Может быть логином или логином и именем, если Имя, Фамилия и Отчество указаны в профиле пользователя.
{{TOPIC_COUNT}} Количество затрагиваемых страниц.
{{TOPIC_ID}} ID страницы, в которую были внесены изменения (о том, что такое ID страницы, можно узнать здесь: Создание страницы
{{TOPIC_STATUS}} Cостояние рабочего процесса страницы, в которую были внесены изменения.
{{TOPIC_STATUS_COLOR}} Цветовое выделение статуса рабочего процесса страницы, в которую были внесены изменения.
{{TOPIC_TITLE}} Название страницы, в которую были внесены изменения.
{{TOPIC_URL}} Ссылка на страницу, в которую были внесены изменения.
{{TRANS_ASSIGNED_TO_USER_PROFILE_HTML}}
Ссылка на профиль нового исполнителя для переводного документа.
{{TRANS_ASSIGNED_TO_USER_PROFILE_NAME}}
Имя нового исполнителя переводного документа. Может быть логином или логином и именем, если Имя, Фамилия и Отчество указаны в профиле пользователя.
{{TRANS_ID}} Идентификатор переводного документа, в который были внесены изменения (вместо ID будет отображаться имя, если переводной документ не является страницей).
{{TRANS_NAME}} Название переводного документа, в который были внесены изменения.
{{TRANS_STATUS}} Состояние рабочего процесса переводного документа, в который были внесены изменения.
{{TRANS_STATUS_COLOR}} Цветовое выделение статуса рабочего процесса переводного документа, в который были внесены изменения.
{{TRANS_URL}} Ссылка на переводной документ, в который были внесены изменения.
{{UPDATED_TOPICS_HTML}}
Список страниц, которые были обновлены, включая ссылки на них.
{{USER_FIRST_NAME}} Имя пользователя, которому отправляется сообщение.
{{USER_LOGIN}} Логин пользователя, которому отправляется сообщение.
{{USER_NOTIFICATION_SETTINGS_URL}} Ссылка на раздел «Уведомления по электронной почте» настроек профиля пользователя, которому отправляется сообщение.
{{USER_PROFILE_URL}} Ссылка на профиль пользователя, которому отправляется сообщение.
{{VIEW_CHANGES_LINK_HTML}}
Кнопка, которая открывает страницу просмотра версий со сравнением последней и предыдущей версий страницы. Кнопка не появится, если изменения были сделаны только в названии страницы.
{{VIEW_MENTION_LINK_HTML}}
Кнопка, которая открывает упоминание. Для комментариев рецензента открывает страницу и подсвечивает комментарий рецензента.