How to add an unsubscription management link to an email
The extension includes a dedicated Unsubscription Management Page that lets recipients choose exactly what they want to unsubscribe from, instead of being silently removed with a single click.
When a recipient opens this page, they can select any combination of:
- Emails from this series — unsubscribe from the specific trigger that sent the email
- All email series — unsubscribe from all Follow Up Email triggers
- Newsletter — unsubscribe from the Magento newsletter
After submitting the form, a confirmation page is displayed.
Adding the link to a template
Liquid syntax (recommended)
<a href="{{ url.unsubscriptions_url }}">Manage email preferences</a>
PHP callout syntax
<a href="<?php echo $this->getUnsubscriptionsUrl() ?>">Manage email preferences</a>
The link is hash-based and unique per email. It does not require the recipient to be logged in.
The page automatically identifies which trigger the email belongs to using the hash from the queue record.
Page behavior
- The recipient's email address is shown at the top of the page.
- If the email was sent by a specific trigger, the option Emails from this series is pre-checked.
- The recipient selects what to unsubscribe from and submits the form.
- A success page confirms that preferences have been saved.
If the hash in the link is missing or invalid, the recipient is redirected to the store homepage with an error message.
Comparison with direct unsubscribe links
| Method | Behavior |
|---|---|
getUnsubscribeUrl / url.unsubscribe_url | Immediately unsubscribes from the current trigger (no confirmation page) |
getUnsubscribeAllUrl / url.unsubscribe_all_url | Immediately unsubscribes from all triggers (no confirmation page) |
getUnsubscribeNewsletterUrl / url.unsubscribe_newsletter_url | Immediately unsubscribes from all triggers and the Magento newsletter (no confirmation page) |
getUnsubscriptionsUrl / url.unsubscriptions_url | Opens the management page — recipient selects what to unsubscribe from |
Use the management page link when you want to give recipients granular control and reduce unsubscribe rates by offering a partial opt-out.