Email

Send transactional and marketing emails from your project — templates, campaigns, and the provider that delivers them.

The Email module sends emails from your project — one at a time from a trigger, or to many people at once as a campaign. You write a template once, connect a provider once (AWS SES, Twilio SendGrid, Mailgun, any SMTP server), and every send — from Cloud, a trigger or your own code — uses them. Transactional emails (receipts, security) and marketing emails (newsletters) are kept apart, so a recipient can unsubscribe from marketing and still get their receipts.

Enable the module

Open a project and choose Email in the left menu. While the module is off, Cloud shows this page; press ENABLE. You need email:manage (built-in Administrator).

Email → enable page, shown while the module is off.

After ENABLE, Cloud opens Email → Campaigns, and the Email menu appears. Norbix also creates a Default signature, a Default footer and the Fake integration Test Me (the default), so you can try everything without sending real mail. To turn the module off again, see Settings.

After ENABLE: the Campaigns screen and the Email menu.

Module map

Screen	What it is for
Campaigns	Send one template to many recipients now or later; follow every batch and message.
Templates	The subject and MJML body per language, with tokens; Marketing or Transactional.
Signatures	Reusable sender blocks your templates insert.
Footers	Reusable bottom blocks, usually with the preferences and unsubscribe links.
Integrations	The providers that deliver the mail, the default one, and their tests.
Settings	Turn the module off.

Not in the menu: the preferences and unsubscribe pages your recipients open from a marketing email.

Your first email

1. Check the integration — Test Me (Fake) is the default; connect a real provider, test it and set it as default when you want real mail.

2. Create a template — for example Welcome email, with a translation for every project language.

3. Send a test — Test in the editor sends it to you.

4. Create a campaign and send it — pick the recipients and the template, press Send.

5. Read the message log — the email exactly as it went out.

Email from a trigger. Email has no triggers of its own: a Send Email action in a Membership, Database, Files or Payments trigger sends a template with the same fields as a campaign (template, provider, language, on behalf of). A trigger run that cannot produce its email — the template misses a project language, the provider was disabled — sends nothing and marks the trigger Needs attention in its module's trigger list. See Triggers.

Use it from code

Every Do it from code block in the Email pages uses this client. Install @norbix.ai/ts (see SDK install):

import { Norbix } from '@norbix.ai/ts';

const projectId = 'pr_40RAGBzUOOnUKKei8uK9ZP';
const norbix = new Norbix({ projectId }); // credentials from the environment

await norbix.hub.notifications.enableEmail();

The CLI lines use the generic norbix hub notifications email … commands of @norbix.ai/cli, signed in, with the project id in NORBIX_PROJECT_ID:

norbix hub notifications email enable

How the examples were run: against a private test stack, with @norbix.ai/ts 4.13.0 and @norbix.ai/cli 1.16.0, signed in as the Cloud account owner (the SDK read the token from NORBIX_BEARER_TOKEN; the CLI used a saved session). The client sends the project id with every call (the norbix-project-id header), so the requests do not repeat it. These are Hub calls: they manage the module and need the matching email:* permission.

Related

Campaigns concept · Message templates · Tokens binding · Integrations concept · Notification preview link · SDK · CLI · API