Mailroom¶
Mailroom — рассылка новостей, которая работает внутри вашего сайта на Grav. Люди подписываются через блок на ваших страницах, подтверждают подписку по почте и попадают в выбранные списки. Вы пишете кампании в Admin Next, отправляете их через плагин Email для Grav и читаете результаты на экранах, которые считают открытия и переходы в вашей собственной базе данных. Всё хранится в базе, которой управляете вы: SQLite по умолчанию, MySQL или PostgreSQL.
Цифры принадлежат вам. Открытие или переход — это отметка времени рядом со строкой отправки, без IP-адреса, браузера и местоположения, и история остаётся, когда вы меняете компанию, которая доставляет вашу почту.
Важно
Продуктам Premium нужен бесплатный плагин License Manager. Установите его и добавьте лицензию продукта перед установкой Mailroom.
Требования¶
| Требование | Примечания |
|---|---|
Grav >= 2.1.0 |
Mailroom несовместим с Grav 1.7 |
PHP >= 8.3 |
С PDO и драйвером вашей базы данных: pdo_sqlite, pdo_mysql или pdo_pgsql |
Плагин API >= 1.0.31 |
Обеспечивает экраны админки и REST API |
Плагин Email >= 5.1.0 |
Вся исходящая почта. Он должен быть настроен и отправлять письма |
| Admin Next | Где вы работаете. Администраторам нужен api.access |
| База данных | SQLite (создаётся для вас, по умолчанию), MySQL или MariaDB, либо PostgreSQL |
Необязательные плагины добавляют больше возможностей:
| Плагин | Что добавляет |
|---|---|
form |
Действие mailroom плагина Form для формы подписки, которую вы определяете сами |
Транспортный плагин, например email-smtp2go, email-amazon, email-sendgrid, email-postmark, email-mailgun, email-mailersend или email-resend |
Отчёты о доставке, возвратах и жалобах через webhook провайдера, а также проверку доставляемости, которая знает вашего провайдера |
Mailroom работает и без них. Без webhook провайдера кампании всё равно отправляются; цифры доставленных, возвратов и жалоб остаются пустыми.
Что входит¶
- Подписчики с записью согласия: предложение, с которым человек согласился, когда и с какого адреса, а также история согласий по каждому изменению его списков.
- Списки, из которых можно выйти по отдельности, каждый со своим двойным подтверждением подписки, центром предпочтений и отпиской одним щелчком из почтового клиента.
- Блок подписки где угодно:
{{ mailroom_form() }}в теме или на странице, действиеmailroomплагина Form или JSON-эндпоинт, на который может отправлять другой сервер. - Кампании в Markdown — в один список, несколько списков или во все списки с сегментом, с тестами темы письма, тестовыми отправками, планированием, отправкой тем, кто присоединился позже, и повторной попыткой для неудачных отправок.
- Сегменты, построенные из условий, теги, шаблоны и автоматизации, которые запускаются при подписке, подтверждении или появлении тега.
- Импорт и экспорт CSV с сопоставлением столбцов, пробным запуском и правилами, которые не дают ушедшим вернуться.
- Проверки доставляемости для SPF, DKIM, DMARC, адреса From, заголовков отписки, скорости отправки, webhook возвратов и ваших процентов возвратов и жалоб.
- Семь отчётов — от эффективности кампаний до часа, в который читают ваши читатели.
- Инструменты конфиденциальности: данные одного человека в виде JSON-файла и удаление по адресу, после которого остаётся только хеш исключения.
- REST API и инструменты MCP для всего, что делает админка.
С чего начать¶
- Установка запускает плагин и подготавливает базу данных.
- Начало работы проходит по адресу сайта, адресу From, блоку подписки, планировщику и вашей первой кампании.
- Списки и формы подписки описывает все способы, которыми люди присоединяются.
Перед первой настоящей кампанией прочитайте Отправку и провайдеров и Доставляемость. Если почта не уходит, начните с Устранения неполадок и Заданий и cron.
В этом разделе¶
- Установка — установить Mailroom, выбрать и защитить его базу данных, настроить cron и выдать администраторам нужные права.
- Начало работы — проверить адрес сайта, задать, от кого приходит почта, поставить блок подписки на сайт, убедиться, что обработчик запускается, отправить первую кампанию и выучить слова Mailroom.
- Отправка и провайдеры — как почта Mailroom уходит через плагин Email, от кого она приходит, как быстро отправляется, какие заголовки несёт и какие webhook провайдеров сообщают о доставке, возвратах и жалобах.
- Списки и формы подписки — списки и их настройки, функция Twig
mailroom_form()и её параметры, несколько списков в виде флажков, действиеmailroomплагина Form и публичные страницы под базовым маршрутом. - Двойное подтверждение подписки и согласие — письмо и страница подтверждения, предложение согласия и что записывается, история согласий каждого человека и что считается уходом по собственной воле.
- Подписчики — таблица подписчиков и её фильтры, страница подписчика с его списками и тегами, добавление людей приглашением или как уже согласившихся и разница между отпиской, удалением, исключением и удалением данных.
- Массовые действия — выбрать подписчиков вручную, по странице или по фильтру, затем добавить или убрать список либо тег, отписать или удалить их и прочитать, что было сделано и кого не тронули.
- Импорт и экспорт — перенести список контактов из другого инструмента с сопоставлением столбцов, предпросмотром и пробным запуском, правила, через которые проходит каждая строка,
import:csvв командной строке и экспорт подписчиков в CSV. - Теги и сегменты — теги как заметки, которые сайт хранит о людях, и сегменты как сохранённые вопросы об аудитории, со всеми полями, операторами и счётчиками, а также о том, как их используют кампании и автоматизации.
- Кампании — написать кампанию, выбрать один список, несколько списков или все списки с сегментом, использовать теги слияния, проверить две темы, отправить тест, отправить или запланировать её, а также приостановить, продолжить, отправить новичкам или повторить неудачное.
- Шаблоны и брендирование — брендированный макет письма и его настройки, простой макет, шаблоны кампаний как отправные точки и переопределение шаблонов писем и страниц Mailroom в вашей теме.
- Автоматизации — письма, которые уходят сами, когда человек подписывается, подтверждает подписку или получает тег, с триггерами, ожиданиями, письмами, тегами, списками и ветвями, рецептом серии приветственных писем и тем, как люди проходят через них.
- Отчёты и отслеживание — как считаются открытия и переходы, не сохраняя ничего о читателе, разметка ссылок для вашей аналитики и семь отчётов с их окнами, экспортом CSV и определениями.
- Доставляемость — проверки экрана Health для вашего домена, транспорта и списка, настройки за ними, предупреждения о доставляемости,
deliverability:check, возвраты и жалобы, а также список исключений. - Отписка и предпочтения — ссылки внизу каждой кампании, страница отписки и списки, из которых она выводит, кнопка отписки одним щелчком в почтовом клиенте, центр предпочтений и просмотр в браузере.
- Конфиденциальность — что Mailroom хранит о подписчике и что никогда не сохраняет, экспорт данных одного человека, удаление адреса и сколько всё хранится.
- API подписки — публичный эндпоинт подписки как справочник JSON со всеми полями, всеми ответами, ловушкой для ботов и ограничением частоты, тем, как записывается источник, и серверным ретранслятором за доверенными прокси.
- Задания и cron — очередь заданий, обработчик и строка планировщика с его
PATH, разгрузка после запроса, что делает один проход обработчика, повторные попытки, письма, удерживаемые из-за адреса сайта, ежедневная уборка и как понять, что обработчик работает. - Конфигурация — каждая настройка Mailroom по вкладкам, с её названием, значением по умолчанию и описанием.
- Справочник CLI — каждая команда
bin/plugin mailroom, её аргументы и параметры и когда её запускать. - REST API — маршруты админки Mailroom под
/api/v1/mailroom, как аутентифицироваться, какое право нужно каждому и маршруты по экранам. - MCP — управлять рассылкой из ИИ-клиента через
grav-mcp, со всеми инструментами Mailroom, нужным им правом и маршрутами, у которых его нет. - Устранение неполадок — начать со
statusи экрана Health, затем исправить частые проблемы: нет адреса сайта, обработчик не запущен, почта не приходит, webhook провайдера отклонены, подписки ограничены по частоте и люди, которых нельзя добавить.