Предусмотрено две одноименных функции: ШаблоныСообщений.СформироватьСообщение для вызова с сервера ШаблоныСообщенийКлиент.СформироватьСообщение для вызова с клиента

1. Для вызова с клиента

Открывает окно выбора шаблона для формирования электронного письма или сообщения SMS по шаблону для переданного в параметре ПредметСообщения предмета.

Синтаксис

Процедура СформироватьСообщение(ПредметСообщения, ВидСообщения, ОписаниеОповещенияОЗакрытии = Неопределено, 
ВладелецШаблона = Неопределено, ПараметрыСообщения = Неопределено) Экспорт

Параметры

• ПредметСообщения — ОпределяемыйТип.ПредметШаблонаСообщения
  • Строка - объект-источник данных, выводимых в сообщение. Для общих шаблонов необходимо передавать значение "Общий". Для передачи предмета сообщения строкой необходимо указывать полное имя метаданных. Например, "Справочник.Контрагенты".
• ВидСообщения — Строка - "Письмо" для электронного письма и "СообщениеSMS" для сообщений SMS.
• ОписаниеОповещенияОЗакрытии — ОписаниеОповещения - оповещение, которое вызывается после формирования сообщения. Содержит:
  • Результат - Булево - если Истина, то сообщение было создано.
  • ПараметрыСообщения - Структура
  • Неопределено - значение, которое было передано в параметре ПараметрыСообщения.
• ВладелецШаблона — ОпределяемыйТип.ВладелецШаблонаСообщения - владелец шаблонов. Если не указан, то в окне выбора шаблона выводятся все доступные шаблоны для указанного предмета ПредметСообщения.
• ПараметрыСообщения — Структура - дополнительная информация для формирования сообщения, которая передается в свойство ПараметрыСообщения параметра ПараметрыШаблона процедуры ШаблоныСообщенийПереопределяемый.ПриФормированииСообщения.

Пример вызова

ШаблоныСообщенийКлиент.СформироватьСообщение(ПредметСообщения, ВидСообщения, ОписаниеОповещенияОЗакрытии, ВладелецШаблона, ПараметрыСообщения)

Доступность

Тонкий клиент, Толстый клиент

2. Для вызова с сервера

Создает сообщение на основании предмета по шаблону сообщения.

Синтаксис

Функция СформироватьСообщение(Шаблон, Предмет, УникальныйИдентификатор, ДополнительныеПараметры = Неопределено) Экспорт

Параметры

• Шаблон — СправочникСсылка.ШаблоныСообщений - ссылка на шаблон сообщения.
• Предмет — Произвольный - объект основание для шаблона сообщений, типы объектов перечислены в определяемом типе ПредметШаблонаСообщения.
• УникальныйИдентификатор — УникальныйИдентификатор - идентификатор формы, необходим для размещения вложений во временном хранилище при клиент-серверном вызове. Если вызов происходит только на сервере, то можно использовать любой идентификатор.
• ДополнительныеПараметры — Структура - список дополнительных параметров, который будет передан в параметр Сообщение в процедурах ПриФормированииСообщения в момент создания сообщения:
  • ЗначенияПараметровСКД - Структура - значения параметров СКД, состав и значения реквизитов для формируемого шаблона определяется средствами СКД.
  • ПреобразовыватьHTMLДляФорматированногоДокумента - Булево - необязательный, по умолчанию Ложь, определяет необходимо ли преобразование HTML текста сообщения содержащего картинки в тексте письма из-за особенностей вывода изображений в форматированном документе.

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

Структура - подготовленное сообщение на основание шаблона для отправки:

• Тема - Строка - тема письма
• Текст - Строка - текст письма
• Получатель - СписокЗначений - получатели письма, где в значении электронная почта получателя, а в представлении получатель письма.
  • Массив из см. НовыйПолучателиПисьма - если в процедуре ПриОпределенииНастроек общего модуля ШаблоныСообщенийПереопределяемый свойство РасширенныйСписокПолучателей равно Истина.
• ДополнительныеПараметры - Структура - параметры шаблона сообщения.
• Вложения - ТаблицаЗначений: ** Представление - Строка - имя файла вложения. ** АдресВоВременномХранилище - Строка - адрес двоичных данных вложения во временном хранилище. ** Кодировка - Строка - кодировка вложения (используется, если отличается от кодировки письма). ** Идентификатор - Строка - необязательный, идентификатор вложения, используется для хранения картинок, отображаемых в теле письма.

Пример вызова

Результат = ШаблоныСообщений.СформироватьСообщение(Шаблон, Предмет, УникальныйИдентификатор, ДополнительныеПараметры)

Доступность

Сервер, Толстый клиент, Внешнее соединение