Vetrix Docs

Communications (Email)

The Communications (Email) area is where you manage every outbound email the instance sends: edit the templates, preview and send test messages, watch the delivery log, monitor the send queue and per-template health, and move templates between instances. Each screen in the group is documented in its own section below.

Where to find it

Open your avatar menu in the top navigation bar and select Admin panel, or go to gitvetrix.com/admin directly. In the admin sidebar, the Communications (Email) group lists Templates, Deliveries, Queue, Health, Import, and Export.

URL pattern: gitvetrix.com/admin/email/…

Email templates

Select Templates to open the template list at gitvetrix.com/admin/email/templates. It shows every outbound email template so you can edit the subject line and body for each one. Drafts are saved per template and published atomically, and the version that was active before a publish is archived so you can roll back to it.

Find a template

  1. Use the Category dropdown to narrow the list. The choices are All categories, Transactional, Notification, and Admin.
  2. Type in the Search box to filter by template name or description.
  3. Read the table, which has a row per template with columns Slug, Category, Status, Last edited, and Actions.

The Status column shows one of Active, Draft pending, or Unpublished, and a count such as "2 drafts" appears beside the badge when a template has unpublished drafts.

Edit a template

  1. Select Edit on the template's row to open the editor at gitvetrix.com/admin/email/templates/<name>.
  2. The header shows the template name and description, its Category, and the merge-field Namespaces it may use.
  3. Edit the content on the three tabs — Subject, Plaintext, and HTML. Each tab is a code editor.
  4. To insert a merge field, use the Merge fields panel on the right. Expand a namespace and select a field to drop its placeholder (for example, {{ .Recipient.Email }}) at your cursor. The System namespace is marked auto because it is supplied for you.
  5. As you type, any problems are listed in a lint issue panel above the editor, with a marker on the affected tab.
  6. Select Save draft to store your changes as a new draft. The button is available only when the editor has unsaved changes.
  7. Select Publish latest draft to make the most recent draft the active version.

The Version history list at the foot of the editor shows each saved version with its version number, locale, timestamp, and a status badge of draft, published, or archived. That list is read-only; to compare versions in detail or restore an earlier one, use the History control described next.

Compare and restore an earlier version

The editor's History control opens a separate Version history panel where you can compare any two saved versions side by side and revert to an earlier one.

  1. In the editor's button row, select History. A panel opens on the right listing every saved version — its version number and locale, its timestamp, and a status badge of draft, published, or archived.
  2. Select Close to dismiss the panel when you are done.

To compare two versions:

  1. Select Diff on the first version you want to compare. Its button changes to A to mark your first pick.
  2. Select Diff on a second version. Its button changes to B.
  3. Read the comparison that appears below the list, headed Diff followed by the two version numbers (for example, Diff v2 → v5). It is split into three collapsible parts — Subject, Plaintext body, and HTML body. Expand each to read its changes; a part with no differences reads (no changes).
  4. To start over, select Diff again on the version marked A to clear both picks, or select Diff on a different version to replace the B pick.

To revert to an earlier version:

  1. Find the version you want to restore and select Revert on its row. This copies that version's content into a new draft; it does not change the active version on its own.
  2. The new draft is added to the version history as the most recent draft.
  3. Select Publish latest draft to make the restored version active, exactly as when publishing any other draft.

Preview and send a test

  1. In the editor, select Preview to open the preview screen at gitvetrix.com/admin/email/templates/<name>/preview.
  2. In Context source, choose the sample data used to render the message: Synthetic fixture, Recent delivery, or Hand-edited JSON.
    • Recent delivery shows a Recent deliveries dropdown. When you pick a real send, a dialog headed Use real delivery context? asks you to confirm before the recipient's data is echoed into the preview.
    • Hand-edited JSON shows a JSON context box where you type the context yourself.
  3. Read the rendered result on the Subject, Plaintext, and HTML tabs on the right. Any rendering Warnings appear above them.
  4. Select Send test email to me to send the rendered message to your own address. A confirmation reports the recipient it was sent to.

Email deliveries

Select Deliveries to open the delivery log at gitvetrix.com/admin/email/deliveries. It is an audit log of every outbound email, with one row per message.

Filter the log

  1. Use the Status dropdown to show only messages with a given status: All statuses, Queued, Sent, Failed, Bounced, or Suppressed.
  2. Type in the Slug box to filter by template name.
  3. Type in the Recipient email box to match a recipient by a partial address.

The table shows the Slug, Recipient, Subject, Status, Attempts, and Created time for each message. Use Prev and Next beneath the table to page through the results; the footer reports the current page and the total number of matches.

Inspect a delivery

  1. Select a row's slug to open the delivery at gitvetrix.com/admin/email/deliveries/<id>.
  2. The summary panel lists the Recipient, Status, Attempts, and Created time, and — when they apply — the Sent time, Next retry time, and SMTP Message-ID.
  3. Read the rendered Subject. If the send failed, a Last error panel shows the reason.
  4. Expand Context snapshot and select Show stored JSON to read the exact data the message was rendered with.

Retry or delete a delivery

  1. Select Retry to re-queue the message. This is available only while the message's status is Failed.
  2. Select Delete to remove the audit row. A dialog headed Delete delivery row? asks you to confirm; this permanently removes the row and cannot be undone.

Email queue

Select Queue to open the send-queue console at gitvetrix.com/admin/email/queue.

This page appears only if your administrator account has the corresponding permission.

The console shows a live snapshot of the email queue and refreshes on its own; the header notes how often it polls. Select Refresh at any time for an immediate update. If the message broker is not reachable, a banner across the top explains that some figures could not be read and are shown as an em-dash rather than as zero.

Read the snapshot

  • The Broker & consumers cards show the Broker state (Connected, Reconnecting, or Disconnected), the Consumers count, a Publish confirms health badge of OK or Degraded, and the Poller reconciles count.
  • The Queue depths cards show Deliver depth (messages waiting to send), Retry / delayed depth (messages awaiting backoff), and Parked depth (dead-lettered messages).
  • The Snapshot detail table repeats every figure as a metric-and-value list.

Pause delivery and use the kill-switches

The Consumer controls section provides three cards. Each action opens a confirmation dialog that spells out its effect before it takes hold.

  • Consumers — select Pause consumers to stop broker-side delivery, or Resume consumers to re-establish it. The card badge reflects whether consumers are currently active.
  • events.enabled — select Disable events.enabled to halt all outbound email-event publishing across the instance, or Enable events.enabled to resume it.
  • email.retry_broker_enabled — select Disable retry broker to stop broker-side retries and fall back to the slower reconcile path, or Enable retry broker to resume them.

Triage parked messages

The Parked messages section lists dead-lettered messages awaiting attention, with columns Routing key, Reason, Attempts, and Parked. For each row:

  1. Select Requeue to re-publish the message to the delivery queue. A dialog asks you to confirm.
  2. Select Purge to drop the message without re-publishing it. A dialog warns that this cannot be undone.

Email deliveries health

Select Health to open the health panel at gitvetrix.com/admin/email/health. It summarizes delivery health per template and lets you send a one-off test message. A link to the deliveries log is provided so you can drill into any failure.

Read per-template health

The Per-template delivery health panel shows a table with one row per template and the columns Template, Status, Attempts, Failed (24h), and Last error. The status text is colour-coded. The table refreshes on its own; select Refresh for an immediate update.

Send a test message

  1. In the Send test email panel, type an address in the Recipient email box.
  2. Select Send test email. A message beside the button reports whether the send succeeded, and shows the failure reason if it did not.

Import email templates

Select Import to open the import screen at gitvetrix.com/admin/email/import. Use it to bring templates in from a bundle exported from another Vetrix instance. Imported changes land as drafts, so nothing goes live until you publish it from the editor.

  1. Select a file in the Bundle file field. Once the bundle is read, its version, export time, author, template count, and checksum are shown.
  2. Select Run dry-run to see what the bundle would change without writing anything. The result groups the templates under New, Updated, and Unchanged, and lists any errors it found.
  3. Select Apply as drafts to write the new and updated templates as drafts. This is available only when the dry-run reported no errors.

Export email templates

Select Export to open the export screen at gitvetrix.com/admin/email/export. Use it to package the currently-published templates into a signed bundle that another Vetrix instance can import.

  1. Select the templates to include using the checkboxes. Use Select all to check every published template, or Clear to reset the selection. With nothing selected, every published template is exported.
  2. Select Download bundle to download the bundle as a JSON file.

If no template has been published yet, the page explains that at least one must be published before a bundle can be exported and offers a link to the template list.