README

Это надстройка над PHPMailer для работы с шаблонами Эта библиотека предназначена для отправки email как сразу, так и по крону, с минимальной (для простоты) поддержкой шаблонов.

Установка

Установка библиотеки

composer require "cri2net/email"

Таблица в БД

Для лучшей интеграции будет удобно создать таблицу в базе данных. Однако это не обязательно для работы. Не забывайте просматривать файл install.sql при обновлениях версии. Также, поддерживаются автоматические SQL миграции на основе пакета placebook/framework-selfupdate

Описание полей:

id: Идентификатор записи
status: Статус отправки
to_email: E-mail получателя
to_username: Имя получателя
created_at: unix время создания записи
updated_at: unix время последнего изменения записи
send_at: unix время фактической отправки sms
min_sending_time: unix время минимального момента времени, когда можно отправлять письмо - для отложенной отправки
type: одно из значений: raw_text, raw_html, html_template (по умолчанию)
template: ключ шаблона
raw_body: текст сообщения, есть поддержка "макросов"
replace_data: JSON строка с правилами замен
settings: JSON строка с массивом настроек (ключи массива должны совпадать с доступными полями PHPMailer)

Логика отправки из БД (по крону)

<?php

use cri2net\email\Email;

$conf = [];
$email = new Email($conf);
$email->sendEmailByCron();

Метод sendEmailByCron по очереди обработает все письма, которые имеют подходящий статус и минимальное время отправки.

Если шаблон задан, класс пытается взять из него контент письма. Шаблон хранится в виде файла {template_name}.tpl в папке, путь к которой нужно задать в параметр $folder класса. Если есть файл __main.tpl, который находится в этой же папке, то класс будет считать, что там находится основная обёртка для письма, а контент письма перезаменит собой макрос {{MAIN_CONTENT}} в тексте этого основного шаблона. То есть, файл __main.tpl должен содержать текст {{MAIN_CONTENT}}, и вместо этого текста будет подключён конкретный указанный шаблон.

В шаблоне можно использовать переменные, обрамленные двойными фигурными скобками: {{some_var}}

Довольно важно указывать текстовую версию для письма. PHPMailer умеет генерировать её на основе html версии, но часто это получается коряво. Чтоб хранить plain text версию в шаблоне (файле), необходимо хранить её по пути {$this->folder}/plain_text/$template.tpl

Также, класс загружает статический контент в inline вложения

cri2net / email

Maintainers

Details