commercekings / module-consent-notification
Connects commercekings/module-consent to commercekings/module-notification: subscriptions need a valid consent, and withdrawing it removes them. Install it for consent-based notifications; leave it out for opt-out.
Package info
github.com/commercekings/module-consent-notification
Type:magento2-module
pkg:composer/commercekings/module-consent-notification
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0||~8.5.0
- commercekings/consent-source: ^0.1
- commercekings/module-consent: ^0.1
- commercekings/module-notification: ^0.1
- magento/framework: ^103.0.4
- magento/module-store: ^101.1
Requires (Dev)
None
Suggests
- commercekings/module-consent-vanilla: A consent banner. Or any package that provides commercekings/consent-source.
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-10-19 17:35:34 UTC
README
Works with Magento 2.4.4+ · Luma and Hyvä · PHP 8.1–8.5
Switch every CommerceKings notification to opt-in with one install.
- One switch. Install it and every notification needs a consent first – no code, no settings. A notification type with its own consent (e.g. a checkbox for a phone number) keeps it: the banner decides only for the others.
- Unsubscribe in one click. Every email gets a signed, scanner-safe unsubscribe link, plus optional RFC 8058 headers that mail clients such as Gmail can show as a button.
- Withdrawal removes the subscription. A shopper says no, and nothing more is sent.
- Only the right browser. A restored cart goes back only to the browser that consented.
The bridge between commercekings/module-consent and commercekings/module-notification. Leave it out and email
notifications run opt-out, with no consent tables; types with their own consent (a phone checkbox) are unaffected.
Installation
composer require commercekings/privacy-bundle:^0.1 bin/magento setup:upgrade
The privacy bundle brings this bridge with our cookie banner. The bridge needs a consent banner – Composer refuses to
install it without one. With your own banner (any package that provides commercekings/consent-source):
composer require commercekings/module-consent-notification:^0.1 vendor/your-banner.
What it does
- Race-safe. The consent check is part of the same database write as the subscription, so a withdrawal at that moment wins; it is checked again at send time.
- In the storefront, features subscribe only when the banner allows it; their opt-out notices are off by default (the banner informs instead).
- Cleans up. Withdrawing a consent removes its subscriptions at once; a daily cron
(
commercekings_consent_notification_stale_cleanup, 03:05) removes those of expired or deleted consents, so a guest's address does not wait for the cart to be deleted. Types with their own permission are left to it.
It adds no tables.
Tested (as of 0.1.0)
- Automated tests: 18 unit, 1 integration and 4 JavaScript tests (unit and JavaScript tests run on every push); 96.2% line coverage by the unit tests.
- End to end on Magento 2.4.9: in the abandoned cart run, withdrawing consent in the banner clears the cart's subscription, and a new choice captures it again.
- Install: a fresh install of every CommerceKings package from GitHub on an empty Magento database, verified.
More
Disclaimer
These modules help you ask for, record and respect your shoppers' choices – they don't make your store compliant on their own. You are responsible for your store's privacy: what you collect, the wording you show, your privacy policy and whether your setup meets the laws that apply to you (e.g. GDPR, ePrivacy, email marketing rules). Get legal advice if you are unsure.
Need it installed, set up or customized? Get in touch →