<h1 class="title">Customizable unsubscription process on mass mailing emails</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/13.0/mass_mailing_custom_unsubscribe"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-13-0/social-13-0-mass_mailing_custom_unsubscribe"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This addon extends the unsubscription form to let you:</p> <ul class="simple"> <li>Choose which mailing lists are not cross-unsubscriptable when unsubscribing from a different one.</li> <li>Know why and when a contact has been subscribed or unsubscribed from a mass mailing.</li> <li>Provide proof on why you are sending mass mailings to a given contact, as required by the GDPR in Europe.</li> <li>Handle discrete unsubscriptions from other recipients that are not a mailing list. On standard module, unsubscriptions from these recipients directly include that mail on the general blacklist.</li> </ul> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id2">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id6">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id1">Configuration</a></h2> <p>You can customize what reasons will be displayed to your unsubscriptors when they are going to unsubscribe. To do it:</p> <ol class="arabic simple"> <li>Go to <em>Email Marketing &gt; Configuration &gt; Unsubscription Reasons</em>.</li> <li>Create / edit / remove / sort as usual.</li> <li>If <em>Details required</em> is enabled, they will have to fill a text area to continue.</li> </ol> <p>For having discrete unsubscriptions from other recipients than the mailing lists, you need to add a glue module that adds 2 fields in the associated model:</p> <ul class="simple"> <li><cite>opt_out</cite>.</li> <li>Either <cite>email</cite> or <cite>email_from</cite>.</li> </ul> <p>See <cite>mass_mailing_custom_unsubscribe_event</cite> for an example.</p> <a name="usage"></a> <h2><a class="toc-backref" href="#id2">Usage</a></h2> <p>Once configured:</p> <ol class="arabic simple"> <li>Go to <em>Email Marketing &gt; Mailings &gt; Create</em>.</li> <li>Edit your mass mailing at wish, but remember to add a snippet from <em>Footers</em>, so people have an <em>Unsubscribe</em> link.</li> <li>Send it.</li> <li>If somebody gets unsubscribed, you will see logs about that under <em>Email Marketing &gt; Unsubscriptions</em>.</li> </ol> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2> <ul class="simple"> <li>This module replaces AJAX submission core implementation from the mailing list management form, because it is impossible to extend it. When this is fixed, this addon will need a refactoring (mostly removing duplicated functionality and depending on it instead of replacing it).</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mass_mailing_custom_unsubscribe%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id5">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id6">Authors</a></h3> <ul class="simple"> <li>Tecnativa</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id7">Contributors</a></h3> <ul class="simple"> <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul> <li>Rafael Blasco</li> <li>Antonio Espinosa</li> <li>Jairo Llopis</li> <li>David Vidal</li> <li>Ernesto Tejeda</li> <li>Pedro M. Baeza</li> <li>Carlos Roca</li> </ul> </li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id8">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/13.0/mass_mailing_custom_unsubscribe">OCA/social</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>