Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Этот серверный класс служит для взаимодействия с объектом электронной почты в скриптах уведомлений. В дополнение к этим методам используйте глобальный объект электронной почты, доступный в скриптах уведомлений.
addAddress(address, displayName)
Используйте этот метод, чтобы добавить указанный электронный адрес в поле Кому записи таблицы Электронная почта(sys_email).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
address | String | Да | Нет |
displayName | String/Null | Нет | null |
Возвращаемое значение:
Type | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.addAddress(current.caller.email, current.caller.display_name); })(current, template, email, event); |
addAddressBcc(address, displayName)
Используйте этот метод для добавления указанного электронного адреса в поле Скрытая копия записи таблицы Электронная почта(sys_email).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
address | String | Да | Нет |
displayName | String/Null | Нет | null |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { if (+event.param_2 > 1000) { email.addAddressBcc( current.assigned_user.manager.email, current.assigned_user.manager.display_name ); } })(current, template, email, event); |
addAddressCc(address, displayName)
Используйте этот метод, чтобы добавить указанный электронный адрес в поле Копия записи таблицы Электронная почта(sys_email).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
address | String | Да | Нет |
displayName | String/Null | Нет | null |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.addAddressCc( current.assigned_user.manager.email, current.assigned_user.manager.display_name ); })(current, template, email, event); |
getAddresses()
Используйте этот метод, чтобы получить адреса получателей.
Возвращаемое значение:
Тип | Описание |
---|---|
Array of Strings | Массив строк, содержащих электронные адреса получателей. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getAddresses(); })(current, template, email, event); |
getAddressesBcc()
Используйте этот метод, чтобы получить адреса получателей, указанных в Скрытой копии письма.
Возвращаемое значение:
Тип | Описание |
---|---|
Array of Strings | Массив строк, содержащих адреса получателей Скрытой копии. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getAddressesBcc(); })(current, template, email, event); |
getAddressesCc()
Используйте этот метод, чтобы получить адреса получателей, указанных в Копии письма.
Возвращаемое значение:
Тип | Описание |
---|---|
Array of Strings | Массив строк с адресами получателей, указанных в Копии письма. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getAddressesCc(); })(current, template, email, event); |
getBody()
Используйте этот метод для получения текста письма.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Текст письма. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getBody(); })(current, template, email, event); |
getFrom()
Используйте этот метод, чтобы получить адрес отправителя.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Строка, содержащая адрес отправителя. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getFrom(); })(current, template, email, event); |
getReplyTo()
Используйте этот метод, чтобы получить адрес, указанный в поле Ответ.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Строка, содержащая адрес, указанный для ответа. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getReplyTo(); })(current, template, email, event); |
getSubject()
Используйте этот метод, чтобы получить тему письма.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Строка, содержащая тему письма. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.getSubject(); })(current, template, email, event); |
setBody(bodyText)
Используйте этот метод, чтобы задать текст письма в поле Обычный текст.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
bodyText | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.setBody(`Дополнительные комментарии: ${current.sys_updated_by.display_name}: "${current.additional_comments}"` ); })(current, template, email, event); |
setFrom(address)
Используйте метод, чтобы изменить значение адреса отправителя в поле От кого исходящего письма. По умолчанию значение поля От кого исходящего письма берётся из поля От кого дефолтного почтового аккаунта. Метод позволяет изменить значение адреса отправителя в поле От кого исходящего письма.
Данный метод не позволяет изменить почтовый аккаунт для исходящего письма. Для изменения почтового аккаунта по умолчанию измените значение системного свойства default.email.account.send.
Значение параметра метода должно соответствовать регулярному выражению, заданному в свойстве email.validation.reg_exp.
Вне зависимости от значения поля От кого исходящего письма, система проводит авторизацию отправки с данными, установленными в почтовом аккаунте по умолчанию.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
address | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.setFrom('test@example.com'); })(current, template, email, event); |
setReplyTo(address)
Данный Используйте метод позволяет , чтобы установить адрес в поле Ответ. Значение переданного параметра должно соответствовать регулярному выражению, заданному в свойстве email.validation.reg_exp.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
address | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.setReplyTo('test@example.com'); })(current, template, email, event); |
setSubject(subject)
Используйте этот метод, чтобы установить тему письма.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
subject | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Этот метод не возвращает значение. |
Пример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(function runNotificationScript( /* SimpleRecord */ current, /* SimpleTemplatePrinter */ template, /* SimpleEmailOutbound */ email, /* SimpleRecord */ event ) { email.setSubject('Появились новые комментарии'); })(current, template, email, event); |
Table of Contents | ||||
---|---|---|---|---|
|