В этом разделе перечислены свойства и методы плагина PluginSmtpClient

Назначение

Плагина PluginSmtpClient предназначен для отсылки E-Mail уведомлений в контексте JavaScript
(с поддержкой ssl/tls шифроования)

Использование

Перед использованием плагина, его необходимо подключить командой 

// Загрузить плагин и присвоить его объект переменной
var pluginSmtpClient = post.loadPlugin('PluginSmtpClient');

// Рекомендуется воспользоваться следующей конструкцией
//-------------------------------------------------- Загрузка плагина
(function(){
    try{String(SmtpClient)}catch(e){
        // Загрузить плагин и Установить в JS конструторы объектов
        post.loadPlugin('PluginSmtpClient').install(scriptEngine);
    }
})();
//--------------------------------------------------

Свойства

SmtpError Глобальный объект с ошибками соединения


// Загрузить плагин и Установить в JS конструторы объектов
post.loadPlugin('PluginSmtpClient').install(scriptEngine);

// После установки конструкторов, в контексте JS будет доступен объект SmtpError
//SmtpError = {
// "ConnectionTimeoutError": 1,
// "ResponseTimeoutError": 2,
// "SendDataTimeoutError": 3,
// "AuthenticationFailedError": 4,
// "ServerError": 5,
// "ClientError": 6
//}

// Вывести в лог объект SmtpError
post.log('i', '|\n|Ошибки соединения|\n SmtpError = ' +
         JSON.stringify(SmtpError, null, 1));

RecipientType Глобальный объект с типом получателя

// Загрузить плагин и Установить в JS конструторы объектов
post.loadPlugin('PluginSmtpClient').install(scriptEngine);

// После установки конструкторов, в контексте JS будет доступен объект RecipientType
//RecipientType = {
// "To":  1, /* primary            - Основной       */
// "Cc":  2, /* carbon copy        - Копия          */
// "Bcc": 3  /* blind carbon copy  - Скрытая Копия  */
//}

// Вывести в лог объект RecipientType
post.log('i', '|\n|Ошибки соединения|\n RecipientType = ' +
         JSON.stringify(RecipientType, null, 1));

Encoding Глобальный объект с типом содержимого

// Установить в JS конструкторы объектов
pluginSmtpClient.install(scriptEngine);

// После установки конструкторов, в контексте JS будет доступен объект Encoding
//Encoding = {
// "QuotedPrintable":  0,
// "_7Bit":   7,
// "_8Bit":   8,
// "Base64": 64
//}

// Вывести в лог объект Encoding
post.log('i', '|\n|типы содержимого|\n Encoding = ' +
         JSON.stringify(Encoding, null, 1));

Методы

objPlugin pluginSmtpClient.install(scriptEngine) Функция

установка в JS конструкторов объектов
ВНИМАНИЕ! начиная с версии svn.r959 функцию .install() вызывать нет необходимости, ее вызов происходит в функции post.loadPlugin()

// Загрузить плагин и Установить в JS конструторы объектов
var plg = post.loadPlugin('PluginSmtpClient').install(scriptEngine);

после выполнения этого метода, для создания экземпляров объектов используется оператор new

// Создать объект, к свойствам и
// методам которого можно обращаться в стиле Qt
var smtp = new SmtpClient();

Чтобы не использовать функцию install несколько раз (а это возможно, если вы подключаете хелперы типа jcjsHelper_Db.js, который использует два плагина), рекомендуется загрузку плагина обернуть в такую конструкцию 

try{String(SmtpClient)}catch(e){
    // Загрузить плагин и Установить в JS конструторы объектов
    post.loadPlugin('PluginSmtpClient').install(scriptEngine);
}

String pluginSQL.objects() Функция

Вывести список всех поддерживаемых объектов

var allSupportObjects = pluginSmtpClient.objects();
post.log('i', 'Установлены конструкторы объектов:\n' + allSupportObjects);
// переменной allSupportObjects присвоится строка
//  'SmtpClient, EmailAddress, MimeMessage, MimeText, MimeHtml, MimeFile, MimeAttachment, MimeInlineFile'

В этом разделе описано назначение объектов плагина PluginSmtpClient

  • Плагины

  • PluginSmtpClient

    1. SmtpClient - для рассылки E-Mail уведомлений в JS контексте поста
    2. EmailAddress - Тип данных
    3. MimeMessage - Тип данных
    4. MimeText - Тип данных
    5. MimeHtml - Тип данных
    6. MimeFile - Тип данных
    7. MimeAttachment - Тип данных
    8. MimeInlineFile - Тип данных

  • Описание объектов