Vestnik

Package Description

Vestnik — Transactional Email Notifications for MODX 3 ====================================================== Vestnik turns your site's events into emails. When something happens (registration, order, payment, publishing, a contact request) the right people automatically receive an email based on a predefined template. Message texts, recipients and rules are all configured in the manager — no code changes required. For custom cases you can trigger events from a snippet or from your own component's code. Vestnik separates three things that are usually tangled together inside chunks and plugins: the EVENT (what happened), the RULE (who to notify and with which template) and the TEMPLATE (how the email looks). Every message follows one predictable path: event → rule → recipients → template → queue → cron send → log. Features -------- - Configure everything in the manager (CMP): rules, templates, queue, log — no programming needed. - Templates use native MODX tag syntax: [[+username]], escaping [[+fullname:htmlent]], conditions and branching via standard output filters. - Flexible recipients: administrator (address from a system setting), the event user itself, an explicit address (or several), or all active members of a chosen MODX user group. - Passing data is simple: any key from the array/JSON becomes a [[+key]] placeholder in the subject and body. - Three ways to fire an event: * standard MODX system events (caught automatically by a plugin); * a snippet: [[!vestnik_notify? &event=`...` &data=`...`]]; * from code: $modx->services->get('Vestnik')->trigger('order.paid', $data); - Reliable delivery through a queue: cron-based sending, automatic retries on SMTP failure, and a log with the result of every send. - A "Test send" button to preview an email's markup at any address. - Extension points for developers — custom system events OnVestnikBeforeQueue, OnVestnikBeforeSend, OnVestnikAfterSend: cancel a send conditionally, enrich template data, collect your own stats, or call an external webhook — all without touching the component's code. - The core is designed with other channels in mind (Telegram, SMS); the current version ships with email. Typical use cases ----------------- - E-commerce: notify the customer about their order and alert managers (a user group) about a new order. - Registration: a welcome email to a new user. - Contact forms: notify the administrator about a new request. - Publishing: notify editors about new content. - Any business event of your own component via a trigger() call. Requirements ------------ - MODX Revolution 3 - A configured cron job (to send queued emails) - Working mail delivery on the server (SMTP/mail)