Install and enable

• Bicrypto core installed and running — see Installing Bicrypto
• Outbound mail works: a password-reset email from your install arrives in a real inbox
• The cron PM2 app is running — campaigns are sent by a scheduled job and nothing else
• Redis reachable, because the cron scheduler runs on BullMQ
• The MailWizard purchase code from your MashDiv dashboard to hand
• A shell on the server — installing the release ends with one command run there

1. Open the Extension Manager — Admin → System → Extension Manager, at /admin/system/extension. On the Extensions tab, or by searching for MailWizard, find the MailWizard card — product ID 45613491 — and click it. Until its licence is activated the card reads Activate and its switch is disabled, with the tooltip Activate license first.

   1. The MailWizard card — click it to open the product page
   2. Its switch stays disabled until the licence is activated

2. Activate the licence — the product page shows a License Required chip; press Activate License. Paste the purchase code from your MashDiv dashboard, optionally an email address for update notifications, and press Activate License. The screen confirms License Activated! and returns you to the product page a couple of seconds later. If the server has no outbound access, the License File tab on the same screen takes the licence certificate downloaded from your MashDiv dashboard instead.

   1. Paste the purchase code here
   2. Activate License — then wait for the redirect back to the product page
   3. The offline route, for a server with no outbound HTTPS

3. Install the release — back on the product page, now licensed, the Overview tab has a release panel. If it offers Install v…, press it; if it says Up to date on a product you have only just licensed, press Check for Updates once, then install whatever it offers. The Releases tab holds the notes for the version being offered — read them first.

   Install downloads the release, verifies it and extracts it over the project root. It runs no migrations, builds nothing and restarts nothing, so finish it from a shell on the server:

   pnpm updator

   That is the finalise chain — stop, dependencies, schema, seed data, frontend build, start — and it is what creates the three tables below and brings the cron process back up on the new code. If the panel still says Up to date after the check there is nothing to download; go straight to the next step.

   1. Check for Updates, then Install v… when it is offered
   2. Releases — the notes for the version you are about to install
   3. The Enabled switch — step 4, not yet

4. Switch it on — turn the Enabled switch on, in the product page heading or on the MailWizard card in the Extension Manager, which is usable now that the licence is verified. This is what puts Email Marketing in the admin navigation and hands processMailwizardCampaigns to the scheduler, which picks it up within about a minute without a restart. The addon's internal name is mailwizard; that is the category its job sits under at /admin/system/cron and the name that appears in the cron log.

5. Confirm the menu appears — Extensions → Business Tools → Email Marketing in the admin navigation, landing on /admin/mailwizard/campaign.

6. Confirm the addon's own header — the MailWizard screens carry their own three-item nav: Campaigns, Templates, Blocks.

Turning the Enabled switch off — on the product page, or on the MailWizard card in the Extension Manager — stops the campaign cron within about a minute: the scheduler re-checks which add-ons are enabled on a 60-second loop and deregisters the job without a restart. Campaigns, templates and blocks are left alone, so switching back on picks up exactly where you were, and the licence stays in place, so it needs no reactivation. A campaign left ACTIVE when you disable the addon simply stops progressing.

The Add Targets dialog reads the platform's own user list through /api/admin/crm/user, which is gated by view.user — a core CRM permission, not a MailWizard one. A role holding every key in the table above and not view.user opens the picker to an empty list with no error, so the operator concludes there are no users to email.

Scheduled jobs run in the cron PM2 app. If that process is stopped, crashed or never started, every campaign sits at ACTIVE and 0% forever, and nothing in the MailWizard screens says so. pm2 list is the check. See Processes and ports.

The Campaigns screen has one indicator for this: the Stalled Sends figure counts campaigns that are ACTIVE but have not been written to in over an hour. On a healthy install that number is zero.

The platform's global outbound kill switch is checked by the notification queue and by the templated sendEmail path. The MailWizard send loop calls the mailer directly and never consults it. Setting MAIL_DISABLED=true on a staging copy of production silences the rest of the platform and leaves any ACTIVE campaign sending real email to real customers.

Before restoring a production database onto a test box, set every campaign to PENDING or CANCELLED — or switch MailWizard off in the Extension Manager outright.

1. Create a template — Templates → Create, name it Smoke test, drop a text block onto the canvas with a recognisable sentence in it, and save. Reopen it from the list; the canvas should show what you built, not a blank page.

2. Create a campaign — Campaigns → Create. Name and subject anything, pick the Smoke test template, set Emails per hour to 1.

3. Add exactly one recipient — click Add Targets, search for your own account by first name (the search matches first name only), tick it, and Add selected. Save the campaign.

4. Start it — on the campaign page press Start. The status becomes ACTIVE.

5. Run the job rather than waiting an hour — open /admin/system/cron, find processMailwizardCampaigns under the mailwizard category and trigger it.

6. Check the outcome — the recipient card should badge Sent, progress should read 100%, and the campaign status should be COMPLETED. The email should be in your inbox.

pnpm updator