Mail api

Скачать 42.09 Kb.

Название	Mail api
Тип	Документы

rykovodstvo.ru > Руководство эксплуатация > Документы

Клиент-Коммуникатор
logo

«БМикро», Санкт-Петербург, 197136,ул. Всеволода Вишневского, д. 4, этаж 2. тел. +7 (812) 380-4-380 e-mail: info@bmicro.ru

Mail API

Рассылка почты осуществляется при помощи компонента TDBMailStore.
Сводная таблица методов и свойств TDBMailStore

Имя	Тип данных	Описание	Значение по умолчанию или возвращаемое значение
Свойства
ClassID	int	ID класса к которому привязан шаблон рассылки. Требуется указывать только при создании нового шаблона перед вызовом метода Design. Значение принимается только при TemplateID = 0.	0
TemplateID	int	ID шаблона рассылки из таблицы _STMailTemplates базы данных. Требуется указывать перед вызовом методов Design и SendTemplate	0
ShowEditorOnSend	bool	Показывать или нет редактор при рассылке	True (Показывать)
SendOnlySelected	bool	Обрабатывать все или выделенные записи источника рассылки	True (Только выделенные)
SourceDataSet	TX2Query	Источник данных рассылки. Требуется указывать перед вызовом SendTemplate	NULL (Не инициализирован)
SendCompleteSQLProc	string	Имя SQL процедуры которая будет обрабатывать результаты рассылки
Методы
Design	bool	Вызов редактора шаблона. Для создания шаблона перед вызовом необходимо указать ClassID, к которому будет привязан шаблон. Для редакции шаблона перед вызовом необходимо указать TemplateID.	True – если шаблон был сохранён False – если пользователь закрыл редактор без сохранения
SendTemplate	bool	Рассылка шаблона. Перед вызовом необходимо указать сначала TemplateID и SourceDataSet. Установка SourceDataSet при TemplateID = 0 приведёт к генерации ошибки.	True – если рассылка добавлена в очередь рассылки

Примеры использования

Создание нового шаблона:

DBMailStore = this.create(“TDBMailStore”,this,”DBMailStore”)

DBMailStore.ClassID = 5

DBMailStore.Design
Редакция существующего шаблона:

DBMailStore = this.create(“TDBMailStore”,this,”DBMailStore”)

DBMailStore.TemplateID = 1

DBMailStore.Design

Отправка шаблона:

DBMailStore = this.create(“TDBMailStore”,this,”DBMailStore”)

DBMailStore.TemplateID = 1

DBMailStore.SourceDataSet = this(“MyDataSet”)

DBMailStore.ShowEditorOnSend = false

DBMailStore.SendOnlySelected = false

DBMailStore.SendCompleteSQLProc = “[dbo].[MyProcedure]”

DBMailStore.SendTemplate

Хранимая процедура для обработки результатов отправки

Для обработки результатов рассылки на стороне SQL сервера необходимо создать процедуру вида [dbo].[MyProcedure] @TemplateID int, @XML varchar(max). Названия параметров изменять нельзя, так как это приведёт к генерации ошибки.
Параметры процедуры:

@TemplateID – Id шаблона из таблицы _STMailTemplates

@XML – результирующая таблица в формате xml.
Поля результирующей таблицы:

ObjID – ID записи таблицы, к которой привязан шаблон (ObjectID, которые были выбраны в SourceDataSet). Id класса можно извлечь из таблицы _STMailTemplates с помощью параметра процедуры @TemplateID (см. пример).

Sended – результат отправки. 1 – письмо принято сервером, 0 – письмо отвергнуто сервером, NULL – отправка не производилась (такая ситуация может быть из-за сбоя SMTP-сервера в процессе рассылки).

ErrDesc – описание ошибки возвращённое сервером SMTP. Заполнено только в том случае, когда Sended = 0
Пример:

CREATE procedure [dbo].[TestSendMail] @TemplateID int, @XML varchar(max)

AS
DECLARE @ClassID int, @idoc int

DECLARE @SendResult TABLE([ObjID] int,[Sended] bit,[ErrDesc] varchar(255))
SELECT @ClassID = ClassID FROM dbo._STMailTemplates WHERE ID = @TemplateID
EXEC sp_xml_preparedocument @idoc OUTPUT, @XML
INSERT @SendResult

SELECT * FROM OPENXML (@idoc, '/ROOT/SENDRESULT',1)

WITH ([ObjID] int, [Sended] bit,[ErrDesc] varchar(255))
EXEC sp_xml_removedocument @idoc

Похожие:

	Начало сессии (Login) Для начала работы клиента с api, необходимо завести ему Логин и Пароль в рс "api авторизация"		При работе через api следует последовательно пройти следующие шаги Структура api реализована по архитектуре rest odata коммуникация осуществляется посредством
	Краткое руководство по разработке плагинов с использованием iikoFront Api v1 В случае досрочного завершения работы плагина (например, вследствие необработанного исключения) iikoFront не перезапускает плагин....		Сгу фонд государственного имущества кбр, г. Нальчик, проспект Ленина,... ...
	Ооо «икц «Промбезопасность» Хабаровск, ул. Комсомольская, 75-б, оф. 1 тел/факс (4212) 41 33 54 e-mail: ecc, rodina. 1@mail ru		Кальдин константин Михайлович Россия. Г. Владивосток, ул. Русская 17-908. т. 4232 766710, e-mail: flagman-14@mail ru
	649435, Республика Алтай, с. Кулада, ул. Я. Бедюрова, 27 Тел. 8(38845)... Пояснительная записка		Рабочая программа дополнительного образования «Легоконструирование и робототехника» Челябинск, ул. Молдавская, д. 23 «б», тел. (факс) 8 (351) 742-89-89, e-mail mounosh95@mail ru
	Сравнительная характеристика методов определения органического углерода в почвах Фгаоу во «Южный федеральный университет», Ростов-на-Дону, e-mail: nastenka-30-06@mail ru		Руководство разработчика Описания системных служб, возможностей интеграции и управления основным функционалом, api для разработчиков дополнительных плагинов...
	Московской области муниципальное автономное общеобразовательное учреждение Московская область, город Домодедово, микрорайон Южный, ул. Курыжова, стр. 27. E-mail: dom school 9@mail ru		Отчет заведующего государственного бюджетного дошкольного образовательного... Севастополь, с. Терновка, ул. Зелёная, д. 8-а., тел.(0692) 63-94-89, 63-93-40, e- mail: ck dyz61@mail ru
	"Строительная компания "Титан" (ооо "СК"титан") Красноярск, ул. Вокзальная, 21, офис 7; т: 8 (391) 276-00-91, 250-33-01; e-mail: 2503301@mail ru		Для подготовки специалистами ао «Сиборгрэс» технико-коммерческого... Новосибирск, ул. Планировочная, дом 18/1 тел./факс +7(383) 351-77-01, e-mail
	Инструкция по приезду на внксф-15 Оргкомитет настоятельно рекомендует заранее (до 20. 03. 2009) сообщить, как Вы будете прибывать на внксф-15, по e-mail: vnksf15@mail...		Учреждение муниципального образования город краснодар «детский сад... УЛ. Им. 40-летия победы, 29/1, тел/факс (861)257-05-33, e-mail: skazka2007@mail ru

Руководство, инструкция по применению