Отложенная отправка писем при помощи FormIT + Scheduler

Сегодня в нашем телеграм-чатике задали вопрос —
Можно ли как то реализовать отложенную отправку письма, через форму formIT.

Этот вопрос напомнил мне о моих планах, написать инструкцию именно об этом.
По сути подобная задача уже реализована в miniShop2 на базе компонента Scheduler, не так давно опубликованного в Modstore.pro.

Итак, давайте разберемся как же все таки отправить отложенное письмо при помощи FormIt + Scheduler


Как отправлять письма используя FormIt — все знают. Вызываем сниппет FormIT (или, использующие его компоненты ajaxForm, FetchIT). В качестве хука указываем email, который берет на себя функционал мгновенной отправки писем. Если нужно отложить отправку, то напишем свой хук, который будем подключать вместо email;

Шаг 1

Создадим пару сниппетов, необходимых на следующих шагах

scheduler_hook

Это хук, который будем подключать в вызов ajaxForm, вместо email

<?php

/** @var Scheduler $scheduler */
$path = $modx->getOption(
    'scheduler.core_path',
    null,
    $modx->getOption('core_path') . 'components/scheduler/'
);
$scheduler = $modx->getService('scheduler', 'Scheduler', $path . 'model/scheduler/');
$task = $scheduler->getTask('formit', 'form_email');

// Перечисляем какие поля вы заполняете в сниппете, из тех что требуются для отправки писем
$fields = [
    'emailTo',
    'emailSubject',
    'successMessage',
    'fields'
];
$params = [];
foreach($fields as $key) {
    if (!empty($scriptProperties[$key])) {
        $params[$key] = $scriptProperties[$key];
    }
}

if ($task instanceof sTask) {
     // Здесь можете указать через какое время выполнить задание.   
    // + 1 second - мгновенно,  + 2 minutes,  + 3 hours. 
    //  Также допустимы точные указания времени
    $task->schedule('+1 second', $params);
} 

return true;

send_email

Это сниппет, который позже в фоновом запланированном режиме будет отправлять письмо

unset($scriptProperties['task']);
unset($scriptProperties['run']);
$scriptProperties['hooks'] = 'email';
$_POST = $scriptProperties['fields'];
unset($scriptProperties['fields']);
$modx->runSnippet('FormIt', $scriptProperties);
if (!empty($scriptProperties['successMessage'])) {
    return $scriptProperties['successMessage'];
}
return 'done';

Шаг 2

Далее настроим компонент Scheduler. После установки, перейдите в него, откройте вкладку задания и нажмите создать задание



Заполним задание следующим образом:

• Название — любое произвольное на английском. Я назвал form_email
• Тип задания — на основе сниппета
• Категория — formIT
• Сниппет — созданный на шаге 1 сниппет send_email

Сохраняем

Шаг 3

Замените в вызове formIT или ajaxForm хук email на хук scheduler_hook

После отправки формы, в вашем планировщике должно появиться задание, в котором будет видно заполненные данные клиента, что само по себе уже является плюсом и позволяет отслеживать письма и их содержимое

Шаг 4

Обратите внимание на, то, что компонент запускается сервером через серверный планировщик задач CRON
Чтобы выполнение отложенных задач работало — нужно добавить CRON запись на вашем хостинге. Как это сделать описано в документации Scheduler