From 573ab59a9c1b4714a7de9fa195b6d4aeadd25388 Mon Sep 17 00:00:00 2001 From: OCA Git Bot Date: Mon, 18 Jun 2018 05:31:24 +0200 Subject: [PATCH] [UPD] README.rst --- mass_mailing_custom_unsubscribe/README.rst | 122 ++++- .../static/description/index.html | 472 ++++++++++++++++++ 2 files changed, 593 insertions(+), 1 deletion(-) create mode 100644 mass_mailing_custom_unsubscribe/static/description/index.html diff --git a/mass_mailing_custom_unsubscribe/README.rst b/mass_mailing_custom_unsubscribe/README.rst index 3f626252..bc1d54d5 100644 --- a/mass_mailing_custom_unsubscribe/README.rst +++ b/mass_mailing_custom_unsubscribe/README.rst @@ -1 +1,121 @@ -**This file is going to be generated by oca-gen-addon-readme.** +========================================================== +Customizable unsubscription process on mass mailing emails +========================================================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github + :target: https://github.com/OCA/social/tree/11.0/mass_mailing_custom_unsubscribe + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-11-0/social-11-0-mass_mailing_custom_unsubscribe + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/205/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This addon extends the unsubscription form to let you: + +- Choose which mailing lists are not cross-unsubscriptable when unsubscribing + from a different one. +- Know why and when a contact has been subscribed or unsubscribed from a + mass mailing. +- Provide proof on why you are sending mass mailings to a given contact, as + required by the GDPR in Europe. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +You can customize what reasons will be displayed to your unsubscriptors when +they are going to unsubscribe. To do it: + +#. Go to *Mass Mailing > Configuration > Unsubscription Reasons*. +#. Create / edit / remove / sort as usual. +#. If *Details required* is enabled, they will have to fill a text area to + continue. + +Usage +===== + +Once configured: + +#. Go to *Mass Mailing > Mailings > Mass 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 + *Mass Mailing > Mailings > Unsubscriptions*. + +Known issues / Roadmap +====================== + +* As version 11 has introduced a new relation type between mailing lists and + contacts that has multiple usability issues that are being reworked by Odoo + to land in version 12, this module falls back to the version 10 behaviour in + which one contact belonged to just one list. +* This module replaces AJAX submission core implementation from the mailing + list management form, because it is impossible to extend it. When + https://github.com/odoo/odoo/pull/14386 gets merged (which upstreams most + needed changes), this addon will need a refactoring (mostly removing + duplicated functionality and depending on it instead of replacing it). In the + mean time, there is a little chance that this introduces some + incompatibilities with other addons that depend on ``website_mass_mailing``. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +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 +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Tecnativa + +Contributors +~~~~~~~~~~~~ + +* Rafael Blasco +* Antonio Espinosa +* Jairo Llopis +* David Vidal + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +This module is part of the `OCA/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mass_mailing_custom_unsubscribe/static/description/index.html b/mass_mailing_custom_unsubscribe/static/description/index.html new file mode 100644 index 00000000..45d21603 --- /dev/null +++ b/mass_mailing_custom_unsubscribe/static/description/index.html @@ -0,0 +1,472 @@ + + + + + + +Customizable unsubscription process on mass mailing emails + + + +
+

Customizable unsubscription process on mass mailing emails

+ + +

Beta License: AGPL-3 OCA/social Translate me on Weblate Try me on Runbot

+

This addon extends the unsubscription form to let you:

+
    +
  • Choose which mailing lists are not cross-unsubscriptable when unsubscribing +from a different one.
    • +
  • Know why and when a contact has been subscribed or unsubscribed from a +mass mailing.
    • +
  • Provide proof on why you are sending mass mailings to a given contact, as +required by the GDPR in Europe.
    • +
+

Table of contents

+ +
+

Configuration

+

You can customize what reasons will be displayed to your unsubscriptors when +they are going to unsubscribe. To do it:

+
    +
  1. Go to Mass Mailing > Configuration > Unsubscription Reasons.
    2. +
  2. Create / edit / remove / sort as usual.
    3. +
  3. If Details required is enabled, they will have to fill a text area to +continue.
    4. +
+
+
+

Usage

+

Once configured:

+
    +
  1. Go to Mass Mailing > Mailings > Mass Mailings > Create.
    2. +
  2. Edit your mass mailing at wish, but remember to add a snippet from +Footers, so people have an Unsubscribe link.
    3. +
  3. Send it.
    4. +
  4. If somebody gets unsubscribed, you will see logs about that under +Mass Mailing > Mailings > Unsubscriptions.
    5. +
+
+
+

Known issues / Roadmap

+
    +
  • As version 11 has introduced a new relation type between mailing lists and +contacts that has multiple usability issues that are being reworked by Odoo +to land in version 12, this module falls back to the version 10 behaviour in +which one contact belonged to just one list.
    • +
  • This module replaces AJAX submission core implementation from the mailing +list management form, because it is impossible to extend it. When +https://github.com/odoo/odoo/pull/14386 gets merged (which upstreams most +needed changes), this addon will need a refactoring (mostly removing +duplicated functionality and depending on it instead of replacing it). In the +mean time, there is a little chance that this introduces some +incompatibilities with other addons that depend on website_mass_mailing.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +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 +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Tecnativa
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

This module is part of the OCA/social project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +