SimpleEmailOutbound

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

addAddress(address, displayName)

---

Используйте этот метод, чтобы добавить указанный электронный адрес в поле Кому записи таблицы Электронная почта (sys_email). Параметры:

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

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

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

Пример:

addAddress()

(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

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

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

Пример:

addAddressBcc()

(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

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

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

Пример:

addAddressCc()

(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	Метод возвращает массив строк с электронными адресами получателей.

Пример:

getAddresses()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddresses();
})(current, template, email, event);

getAddressesBcc()

---

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

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

Тип	Описание
Array of Strings	Метод возвращает массив строк с адресами получателей Скрытой копии.

Пример:

getAddressesBcc()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddressesBcc();
})(current, template, email, event);

getAddressesCc()

---

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

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

Тип	Описание
Arrays of Strings	Метод возвращает массив строк с адресами получателей, указанных в Копии письма.

Пример:

getAddressesCc()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getAddressesCc();
})(current, template, email, event);

getBody()

---

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

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

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

Пример:

getBody()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getBody();
})(current, template, email, event);

getFrom()

---

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

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

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

Пример:

getForm()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getFrom();
})(current, template, email, event);

getReplyTo()

---

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

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

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

Пример:

getReplyTo()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getReplyTo();
})(current, template, email, event);

getSubject()

---

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

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

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

Пример:

getSubject()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.getSubject();
})(current, template, email, event);

setBody(bodyText)

---

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

Параметры:

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

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

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

Пример:

setBody()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setBody(`Additional comments:
${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	Метод не возвращает значение.

Пример:

setFrom()

(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 property.

Параметры:

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

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

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

Пример:

setReplyTo()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setReplyTo('test@example.com');
})(current, template, email, event);

setSubject(subject)

---

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

Параметры:

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

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

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

Пример:

setSubject()

(function runNotificationScript(
    /* SimpleRecord */ current,
    /* SimpleTemplatePrinter */ template,
    /* SimpleEmailOutbound */ email,
    /* SimpleRecord */ event
    ) {
  email.setSubject('Появились новые комментарии');
})(current, template, email, event);