Начало работы¶
Эта страница ведёт от свежей установки к работающей рассылке: блок подписки на сайте, подтверждённый подписчик и первая кампания. В конце — обзор админки и слова, которые использует Mailroom.
Перед началом¶
- Mailroom установлен, и у вас есть
mailroom.manageиmailroom.send, или вы суперпользователь (см. Установку). - Плагин Email может отправлять почту (
bin/plugin email test-email --to=you@example.com).
Проверьте адрес сайта¶
Каждая ссылка в письмах Mailroom (кнопка подтверждения, ссылка отписки, отслеживаемые ссылки) начинается с адреса сайта. Mailroom читает его из собственной настройки Site URL на вкладке Public Pages, затем из Custom Base URL Grav (system.custom_base_url).
Обычно его не нужно задавать. Если не задано ни то, ни другое, Mailroom заполняет Site URL при первом открытии панели управления Admin Next или страницы Mailroom администратором, который может управлять Mailroom (или суперпользователем), используя адрес, по которому он пришёл, и пишет об этом одну строку в журнал Grav. Он делает это только по HTTPS или по обычному HTTP для сайта на этой машине либо в локальной сети (имя localhost, .test, .local, .localhost или .lan, частный адрес). Уже заданное значение никогда не заменяется.
Откройте Settings Mailroom, затем вкладку Public Pages и проверьте, что Site URL — адрес, которым пользуются люди, например https://www.example.com (с подпапкой, если Grav живёт в ней).
Примечание
Запрос посетителя никогда не считается надёжным указанием, где находится сайт, потому что его заголовок Host может написать кто угодно. Пока одна из двух настроек не задана, письма подтверждения и всё, что обработчик отправляет сам, ждут в очереди. Они уходят при следующем запуске обработчика после того, как настройка появится. См. Устранение неполадок.
Укажите, от кого приходит почта¶
На вкладке Sending задайте From Name и From Address или оставьте их пустыми, чтобы отправлять от имени самого плагина Email. В любом случае адрес должен быть тем, с которого ваш почтовый провайдер разрешает отправлять. Используйте настоящий почтовый ящик на своём домене, а не no-reply.
Карточка Can this site send mail? вверху вкладки говорит, установлен ли плагин Email и отправляет ли он письма, какой движок использует и доходят ли до него заголовки отписки. Отправка и провайдеры описывает остальное на вкладке.
Поставьте блок подписки на сайт¶
В свежей установке есть один список, Newsletter (код newsletter), который является списком по умолчанию и просит людей подтвердить подписку. Нарисуйте для него блок подписки в любом месте темы:
или для одного списка по его коду:
В содержимом страницы включите обработку Twig для страницы (process: twig: true в её front matter); mailroom_form() разрешена в содержимом страницы. В блоке есть поле электронной почты, предложение согласия с флажком и кнопка Sign me up. Списки и формы подписки описывают параметры, несколько списков в виде флажков и другие способы подписки.
Подпишитесь и подтвердите¶
- Откройте страницу с блоком в приватном окне.
- Введите адрес, который можете прочитать, поставьте флажок и нажмите Sign me up. Поля сменяются ответом: «We have sent you a confirmation email.»
- Откройте письмо («Please confirm your email address for ...») и нажмите Yes, sign me up.
Страница подтверждения нажимает свою кнопку при загрузке, поэтому вы попадаете на «You are on the list». Откройте Subscribers в Mailroom: вы там, подписаны, с указанием, как вы присоединились (Signup form), когда согласились и какое предложение согласия вам показали.
Письмо подтверждения ушло сразу после подписки, потому что задания, поставленные запросом, выполняются сразу после его ответа. Кампаниям нужен обработчик.
Убедитесь, что обработчик запускается¶
Планировщик Grav должен быть в crontab сайта (см. Установку). Затем запустите:
Она заканчивается строкой «Healthy: the database is current, mail can leave and the queue is moving.» или предупреждением для каждой проблемы, включая строку crontab, которую нужно добавить, когда обработчик не запускался.
Отправьте первую кампанию¶
- Откройте Campaigns и нажмите Write a campaign.
- Задайте Name (его видите только вы), Subject и Message в Markdown. Можно написать
Hello {{ subscriber.first_name|default('there') }},, чтобы обратиться к людям по имени. - В разделе Send it to выберите Newsletter. Счётчик под ним говорит, сколько людей её получат.
- Сохраните. Панель Preview рисует её через настоящий макет с примером подписчика.
- В разделе Send a test введите свой адрес. Тестовая копия придёт с
[Test]перед темой. - Нажмите Send it now и подтвердите.
Кампания уходит, когда её забирает обработчик, со скоростью из Messages Per Minute, а её страница заполняется цифрами отправленных, доставленных, открывших и перешедших. Кампании описывают всё остальное.
Админка¶
Страница Mailroom живёт по /admin/plugin/mailroom, и у каждого экрана есть собственный адрес после #, поэтому перезагрузка или кнопка «Назад» возвращают туда, где вы были (#/campaigns/12, #/subscribers/import, #/health для вкладки Health). Редакторы спрашивают перед уходом с несохранёнными изменениями.
| Вкладка | Что это |
|---|---|
| Overview | Подписанные, ожидающие подтверждения, ушедшие и больше не получающие почту, новые подписчики за 30 дней, последние кампании и их результаты |
| Campaigns | Каждая кампания с её состоянием и процентами, а также редактор кампании. См. Кампании |
| Subscribers | Таблица подписчиков, страница каждого человека, импорт. См. Подписчиков |
| Audience | Списки, теги и сегменты. См. Списки и формы подписки и Теги и сегменты |
| Automations | Письма, которые уходят сами. См. Автоматизации |
| Templates | Отправные точки для кампаний. См. Шаблоны и брендирование |
| Suppressions | Адреса, на которые сайт больше никогда не напишет. См. Доставляемость |
| Reports | Семь отчётов с экспортом CSV. См. Отчёты и отслеживание |
| Health | Проверки доставляемости. См. Доставляемость |
| Settings | Форма настроек плагина и карточки состояния. См. Конфигурацию |
Кнопка Settings над страницей, кнопка Configure плагина и /admin/plugins/mailroom открывают вкладку Settings, поэтому форма настроек одна.
Панель управления Admin Next также показывает баннеры Mailroom всем, кто может читать Mailroom: почта не может уйти, кампания остановила себя, адреса From нигде нет, транспорт отбрасывает заголовок отписки, сегмент не удалось посчитать, проверка доставляемости не проходит, высокий процент возвратов, webhook замолчал или не имеет секрета, и отсутствует адрес сайта.
Слова Mailroom¶
| Термин | Значение |
|---|---|
| Subscriber (подписчик) | Один адрес электронной почты, известный Mailroom, с именем, языком, состоянием, способом присоединения и согласием. |
| Status (состояние) | Где подписчик находится в целом: Ожидает подтверждения (pending), Подписан, Ушёл (unsubscribed), Возврат или Жалоба. |
| List (список) | Тема, в которую человек может вступить и выйти из неё отдельно, с кодом, по которому её называет форма подписки. |
| Membership (участие) | Где один человек находится в одном списке: Ожидает подтверждения, В списке или Ушёл. |
| Double opt-in (двойное подтверждение подписки) | Настройка списка Ask people to confirm: новички получают письмо подтверждения, и им ничего не отправляют, пока они не нажмут кнопку. |
| Consent (согласие) | Предложение, с которым человек согласился (хранится как хеш), когда и с какого адреса. |
| Consent history (история согласий) | Строка на каждое изменение списков человека: подписка, подтверждение, добавление администратором, уход, возвращение, импорт. |
| Tag (тег) | То, что сайт заметил о человеке, например откуда он подписался. Без согласия и без состояния. |
| Segment (сегмент) | Сохранённый вопрос об аудитории, например «не открывал ничего за 90 дней». |
| Campaign (кампания) | Одно письмо, написанное один раз и отправленное в списки, необязательно суженные сегментом. |
| Send (отправка) | Одна кампания или письмо автоматизации одному человеку с тем, что с ним произошло. |
| Automation (автоматизация) | Серия ожиданий и писем, которая запускается сама, когда человек подписывается, подтверждает подписку или получает тег. |
| Suppression (исключение) | Адрес, на который сайт больше никогда не напишет: жёсткий возврат, жалоба или добавленный вручную. |
| Route base (базовый маршрут) | Где отвечают публичные страницы, /newsletter, если не изменено. |
| Worker (обработчик) | bin/plugin mailroom work, запускаемый каждую минуту планировщиком Grav, который отправляет всё из очереди. |