Перейти к основному содержимому
Версия: 1.20.1

SimpleEmailTemplate

Этот класс позволяет пользовательскому скрипту выполнять код на стороне сервера с помощью внешних скриптов. Используйте этот класс для создания уведомлений.

setTitle(title)


Используйте этот метод для настройки основного заголовка почтового уведомления.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
titleStringДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

setTitle()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setTitle(`${current.number} ${current.subject}`);

setBodyHeader(bodyHeader)


Используйте этот метод для настройки заголовка в тексте содержимого почтового уведомления.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
bodyHeaderStringДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

setBodyHeader()
  let bodyHeaderTemplate = `<a href="${currentRecordURL}">${emailSubject}</a> <br> Статус ${current.number} изменился, новый статус: ${current.getDisplayValue('state')}.`;
if(current.state == '3'){ //Отложено
bodyHeaderTemplate += `Повторный запрос: ${current.getDisplayValue('resubmission')}`;
}
bodyHeaderTemplate += `<br><br>Вы можете дополнить информацию в ответном письме. Не меняйте тему письма. `;
htmlTemplate.setBodyHeader(bodyHeaderTemplate);

setBodyText(bodyText)


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

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
bodyTextStringДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

setBodyText()
const htmlTemplate = new SimpleEmailTemplate(approvalItem.getDisplayValue());
const allApproversObject = JSON.parse(current.additional_parameter);
htmlTemplate.setBodyText(`Уважаемый ${current.getDisplayValue('approver_id')}, согласуйте <a href="${ApprovalItemURL}">${approvalItem.getDisplayValue()}</a> Список задач на согласование: ${transformToTemplateList(allApproversObject)}`);

setComment(comment)


Используйте метод для настройки комментариев в почтовых уведомлениях:

  • расположение комментариев в поле на сером фоне.
  • подсветка курсивом.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
commentStringДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

setComment()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setComment(`Comment: ${current.additional_comments}`);

getTitle()


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

Возвращаемое значение:

ТипОписание
StringМетод возвращает основной заголовок уведомления.

Пример:

getTitle()
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setTitle(`${current.number} ${current.subject}`);
ss.info(htmlTemplate.getTitle()); // Результат: INC0000XXX Email не работает

getBodyHeader()


Используйте метод, чтобы получить основной заголовок основного текста.

Возвращаемое значение:

ТипОписание
StringМетод возвращает основной заголовок содержимого.

Пример:

getBodyHeader()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setBodyHeader(`Инцидент ${current.number} ${current.subject}`);
ss.info(htmlTemplate.getBodyHeader()); // Результат: Инцидент INC0000XX Email не работает

getBodyText()


Используйте метод, чтобы получить основной текст письма.

Возвращаемое значение:

ТипОписание
StringМетод возвращает основной текст.

Пример:

ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setBodyText(`Описание ${current.description}`);
ss.info(htmlTemplate.getBodyText()); // Результат: Описание 27.01.2022 Не смог зайти в свой email, ошибка 'Нет доступа'.

getComment()


Используйте метод, чтобы получить текст комментариев.

Возвращаемое значение:

ТипОписание
StringМетод возвращает текст комментариев.

Пример:

getComment()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setComment(`Комментарий: ${current.additional_comments}`);
ss.info(htmlTemplate.getComment()); // Результат: Необходимо больше информации

getButtons()


Используйте данный метод, чтобы получить массив кнопок.

Возвращаемое значение:

ТипОписание
ArrayМетод возвращает массив кнопок.

Пример:

getButtons()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Согласовать', 'https://instance.example.com');
ss.info(htmlTemplate.getButtons()); // Результат: [{"text":"Согласовать","url":"https:\/\/instance.example.com\/","color":"#05C270"},{"text":"Отклонить","url":"https:\/\/instance.example.com\/","color":"#F73422"}]

addButton()


Используйте этот метод, чтобы добавить новую кнопку к массиву кнопок.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
textStringДаНет
urlStringДаНет
colorStringНетНет
buttonArrayArrayДаНет

Возвращаемое значение:

ТипОписание
ArrayМетод возвращает массив кнопок, включая новую.

Пример:

addButtons()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Согласовать', 'https://instance.example.com');

removeButton()


Используйте этот метод, чтобы удалить последнюю добавленную кнопку.

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

removeButton()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Согласовать', 'https://instance.example.com');
if (current.state === '2') { // Статус инцидента 'В работе'
htmlTemplate.removeButton();
}

removeAllButtons()


Используйте этот метод, чтобы удалить все добавленные кнопки.

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

removeAllButtons()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.addButton('Согласовать', 'https://instance.example.com');
htmlTemplate.addButton('Отклонить', 'https://instance.example.com');
if (current.state === '3') { Статус инцидента 'Отложено'
htmlTemplate.removeAllButtons();
}

setProperty(propertyName, input, propertyTitle)


Используйте этот метод, чтобы задать внутренний метод проверки типа ввода.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
propertyNameStringДаНет
inputString/NumberДаНет
propertyTitleStringДаНет

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

Пример:

setProperty()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setProperty('bodyText', Необходимо больше информации об инциденте', 'Содержимое');
ss.info(htmlTemplate.getBodyText()); // Результат: Необходимо больше информации об инциденте

formEmailTemplate()


Используйте метод, чтобы создать и вернуть HTML шаблон на основе заданных свойств.

Возвращаемое значение:

ТипОписание
StringМетод возвращает шаблон HTML.

Пример:

formEmailTemplate()
ss.importIncludeScript('SimpleEmailTemplate');
const htmlTemplate = new SimpleEmailTemplate('');
htmlTemplate.setTitle(`${current.number} ${current.subject}`);
htmlTemplate.setComment(`Комментарий: ${current.additional_comments}`);
htmlTemplate.setBodyHeader(`Инцидент ${current.number} ${current.subject}`);
htmlTemplate.setBodyText(`Описание: ${current.description}`);
email.setBody(htmlTemplate.formEmailTemplate());