Preferences and unsubscribe pages

The preferences and unsubscribe pages your recipients open from a marketing email.

Where: not in the project menu — they open from the links in a sent email, on your Cloud address: /notifications/preferences?hash=<signed link> and /notifications/email-unsubscribe?hash=<signed link>.

Marketing email must carry a working way to unsubscribe. Every marketing email Norbix sends can carry two signed links: the link itself proves who it is for, needs no sign-in, and Norbix refuses a link that was changed.

Link in the email	Page title	Template call that writes the link
Preferences	Email preferences	@Model.Cmf.GetEmailPreferencesLink()
Unsubscribe	Unsubscribe from marketing emails	@Model.Cmf.GetEmailUnsubscribeFromCategoryLink()

Before you start

• A template or footer with the two links — usually in a footer used by every marketing template:

  <mj-text>
    <a href="@Model.Cmf.GetEmailPreferencesLink()">Manage preferences</a> ·
    <a href="@Model.Cmf.GetEmailUnsubscribeFromCategoryLink()">Unsubscribe</a>
  </mj-text>

  You never fill these on the campaign form; Norbix signs a new link for every recipient when it sends.

• A campaign to users (All users, Specified Users, or a collection of user ids). Campaigns to plain Email Addresses have no user behind each address: the calls write #.

Steps

What the recipient does:

1. Opens Manage preferences from the email. Email preferences shows one sentence, for example [e-mail] receives marketing emails., the button Unsubscribe from all marketing emails, and "You may still receive emails you need, such as account or security messages."

   

   The preferences page from a sent email.
2. Presses Unsubscribe from all marketing emails.

The Unsubscribe link opens Unsubscribe from marketing emails with the same sentence and button. Opening a page alone never unsubscribes anybody — mail scanners open links on their own, so it takes a click.

The unsubscribe page.

Result

A green Unsubscribed box says "You have been unsubscribed from marketing emails.", and the sentence changes to [e-mail] is unsubscribed from marketing emails. Norbix sends a short confirmation email through the project's default integration. Later marketing campaigns skip this address (status BlockedByUserPreferenceBlockAll in the message log); transactional emails still arrive.

Unsubscribed.

A changed, made-up or unsigned link shows This link cannot be used — "This unsubscribe link is not valid." (CM-ERRORS-EMAILS-024) — and nothing is read or changed. A link without a hash says "This link is incomplete. Open the link from the email again."

A changed link is refused.

• The link carries the environment. A link from a TEST campaign unsubscribes in TEST.

• All marketing, not one category. There is no per-category unsubscribe or re-subscribe on these pages yet.

• Bounces and complaints block too with Mailgun and its webhook.

• Changing the gateway's auth key breaks old links. The links are signed with it (NORBIX_GATEWAY_AUTH_JWT_AESKEYBASE64 on self-hosted installs).

• Rate limit: the preferences read answers at most 60 requests per minute from one IP address.

Change or remove it later

A recipient cannot re-subscribe from these pages today. The pages themselves have no settings; change the links by editing the template or footer that writes them.

Do it from code

The signed links of a sent message are in its model (Campaign.PreferencesHash, Campaign.UnsubscribeFromCategoryHash):

const { list } = await norbix.hub.notifications.getEmailCampaignBatchNotifications({ id, batchId });
const link = list.items[0].model['Campaign.PreferencesHash']; // <payload>.<signature>
// open https://<cloud>/notifications/preferences?hash=<link>

norbix hub notifications email campaign batches get --id cmp_7mt3e31YJCj3DNk2oDWxNc

API: Get Email Campaign Batch Notifications