Документерра: руководство пользователя
Шаблоны уведомлений по электронной почте
Шаблоны уведомлений по электронной почте — это HTML-файлы с готовой разметкой, используемые для создания текста темы и основного содержания уведомления, которое система отправляет авторами авторизованный читателям при различных событиях, описанных ниже. Как настроить шаблоны уведомлений по электронной почте, вы можете узнать здесь: Настройка шаблонов уведомлений по электронной почте.
Файлы шаблонов уведомлений по электронной почте находятся в папке /Storage/Templates/Emails. Их имена выглядят следующим образом: CreateUserTemplate.en-US.html.
Список файлов шаблонов уведомлений по электронной почте
Здесь вы найдете описание всех файлов шаблонов уведомлений по электронной почте со списками плейсхолдеров, которые в них используются.
| Файл шаблона уведомления по электронной почте |
Описание |
Плейсхолдеры для тега <head> (шапка) | Плейсхолдеры для тега <body> (основной текст) |
|---|---|---|---|
| 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}} |
| 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}} |
| 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}} |
| 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}} |
| 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}} |
Список доступных плейсхолдеров
Согласно приведенной выше таблице, каждый файл шаблона уведомления по электронной почте может содержать определенные плейсхолдеры в Формате шаблонизатора Mustache, которые заменяются определенным контентом в итоговом сообщении. Ниже приведен полный список доступных плейсхолдеров с краткими описаниями.
| Плейсхолдер |
Описание |
||||
|---|---|---|---|---|---|
| {{ACTION}} | Описание выполняемого действия.
|
||||
| {{API_KEY}} | Сгенерированный ключ API | ||||
| {{COMMENT_HOTSPOT}} | Текстовое содержание комментария рецензента | ||||
| {{COMMENT_DETAILS}} | Более подробная информация о комментарии рецензента, включая текстовое содержание комментария, ссылку на профиль пользователя, выполнившего данное действие, а также дату и время действия. | ||||
| {{CONTENT}} | Используется только в файле OfficialMasterTemplate.en-US.html и заменяется контентом отправленного уведомления. | ||||
| {{MODIFIED_BY_USER_PROFILE_URL}} | Ссылка на страницу профиля пользователя, внесшего изменения | ||||
| {{MODIFIED_BY_USER_PROFILE_HTML}} | Ссылка на страницу профиля пользователя, внесшего изменения, с изображением аватара | ||||
| {{NEW_PASSWORD}} | Новый пароль для пользователя | ||||
| {{PASSWORD}} | Пароль для созданного пользователя | ||||
| {{PASSWORD_RESET_URL}} | Ссылка для сброса пароля | ||||
| {{PROJECT_NAME}} | Название проекта/публикации, в которую были внесены изменения | ||||
| {{PROJECT_NAME_HTML}} | Название проекта/публикации, в котором были внесены изменения, в виде ссылки на проект/публикацию | ||||
| {{PROJECT_URL}} | Ссылка на проект/публикацию, в которую были внесены изменения | ||||
| {{SENT_FROM_URL}} | URL-адрес портала, с которого отправляется сообщение | ||||
| {{TODO_ITEMS_LIST}} | Список задач для страницы, в которую были внесены изменения | ||||
| {{TOPIC_COUNT}} | Количество затрагиваемых страниц | ||||
| {{TOPIC_ID}} | ID страницы, в которую были внесены изменения (о том, что такое ID страницы, можно узнать здесь: Создание страницы | ||||
| {{TOPIC_STATUS}} | Cостояние рабочего процесса страницы, в которую были внесены изменения | ||||
| {{TOPIC_STATUS_COLOR}} | Цветовое выделение статуса рабочего процесса страницы, в которую были внесены изменения | ||||
| {{TOPIC_TITLE}} | Название страницы, в которую были внесены изменения | ||||
| {{TOPIC_URL}} | Ссылка на страницу, в которую были внесены изменения | ||||
| {{TRANS_ID}} | Идентификатор переводного документа, в который были внесены изменения (вместо ID будет отображаться имя, если переводной документ не является страницей) | ||||
| {{TRANS_NAME}} | Название переводного документа, в который были внесены изменения | ||||
| {{TRANS_STATUS}} | Состояние рабочего процесса переводного документа, в который были внесены изменения | ||||
| {{TRANS_STATUS_COLOR}} | Цветовое выделение статуса рабочего процесса переводного документа, в который были внесены изменения | ||||
| {{TRANS_URL}} | Ссылка на переводной документ, в который были внесены изменения | ||||
| {{USER_FIRST_NAME}} | Имя пользователя, которому отправляется сообщение | ||||
| {{USER_LOGIN}} | Логин пользователя, которому отправляется сообщение | ||||
| {{USER_NOTIFICATION_SETTINGS_URL}} | Ссылка на раздел «Уведомления по электронной почте» настроек профиля пользователя, которому отправляется сообщение | ||||
| {{USER_PROFILE_URL}} | Ссылка на профиль пользователя, которому отправляется сообщение | ||||
