OdooWiki OCA HUB

Mass mailing unsubscription metadata

mass_mailing_custom_unsubscribe folder_open OCA/mass-mailing open_in_new
Marketing License: AGPL-3

This addon extends the Odoo subscription engine to provide proof on why you are sending mass mailings to a given contact, as required by the GDPR in Europe. Also, when you unsubscribe from a specific list, it allows you to be redirected to the subscription lists form where the reasons for unsubscribing are visible.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Records technical proof (IP address, browser, language) whenever a contact subscribes, unsubscribes, blocks or unblocks a mailing list, so you can justify mass mailings for GDPR. Also can redirect unsubscribers to the list preferences page.

This module adds a hidden 'metadata' note to mailing subscriptions and to the email blacklist. The note is filled automatically with the visitor's IP address, browser identification and browser language at the moment of the action.

It applies when a contact: - unsubscribes from a mailing list or from a specific document, - updates their list subscriptions, - is added to or removed from the email blacklist, - sends unsubscribe feedback.

The metadata is stored on mailing.subscription and mail.blacklist, and it is also inserted into the message shown in the blacklist history. On the subscription form, the metadata field is only visible to users with the technical 'no one' group and only when it contains something.

A system setting controls whether a person who confirms an unsubscription is redirected (HTTP 302) to the unsubscribe page instead of the standard confirmation page. The module touches the mass mailing unsubscribe web pages and the subscription and blacklist records; it does not add new menus.

Depends on

mass_mailing

Required by other modules

mass_mailing_custom_unsubscribe_event
Models and fields (2)
  • mail.blacklist · extends an existing modelmetadata
  • mailing.subscription · extends an existing modelmetadata

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 7 confirmed, 2 with no information of 9 versions.

Sources · Odoo 18.0

Confirmed on 2026-11-03 in branch 18.0 of OCA/mass-mailing.

terminal Installation and usage

OCA documentation · Odoo 18.0

Configuration

Source · Odoo 18.0

In order to redirect direct unsubscriptions to the Mailing Subscriptions form, you need to create the system parameter mass_mailing.mailing_lists_unsubscribe_manager_redirect with value 1. Otherwise, the redirect won't happen.

Usage

Source · Odoo 18.0

Once configured:

  • Go to Email Marketing \> Mailings \> Create.
  • Edit your mass mailing at wish, but remember to add a snippet from Footers, so people have an Unsubscribe link.
  • Send it.
  • If somebody gets unsubscribed, you will see logs about that under Email Marketing > Reporting > Opt-Out report (List view) > Choose one
  • Choose a Newsletter with Opt Out, open this record and see Metadata field

No verified information in OCA: Installation.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.