[UPD] README.rst

7 years ago · 573ab59a9c
2 changed files with 593 additions and 1 deletions
--- 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 <https://github.com/OCA/social/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 <https://github.com/OCA/social/issues/new?body=module:%20mass_mailing_custom_unsubscribe%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 Do not contact contributors directly about support or help with technical issues.
 Credits
 =======
 Authors
 ~~~~~~~
 * Tecnativa
 Contributors
 ~~~~~~~~~~~~
 * Rafael Blasco <rafael.blasco@tecnativa.com>
 * Antonio Espinosa <antonio.espinosa@tecnativa.com>
 * Jairo Llopis <jairo.llopis@tecnativa.com>
 * David Vidal <david.vidal@tecnativa.com>
 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 <https://github.com/OCA/social/tree/11.0/mass_mailing_custom_unsubscribe>`_ project on GitHub.
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
--- a/mass_mailing_custom_unsubscribe/static/description/index.html
+++ b/mass_mailing_custom_unsubscribe/static/description/index.html
@ -0,0 +1,472 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
 <title>Customizable unsubscription process on mass mailing emails</title>
 <style type="text/css">
 /*
 :Author: David Goodger (goodger@python.org)
 :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 Default cascading style sheet for the HTML output of Docutils.
 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */
 /* used to remove borders from tables and images */
 .borderless, table.borderless td, table.borderless th {
  border: 0 }
 table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }
 .first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }
 .last, .with-subtitle {
  margin-bottom: 0 ! important }
 .hidden {
  display: none }
 .subscript {
  vertical-align: sub;
  font-size: smaller }
 .superscript {
  vertical-align: super;
  font-size: smaller }
 a.toc-backref {
  text-decoration: none ;
  color: black }
 blockquote.epigraph {
  margin: 2em 5em ; }
 dl.docutils dd {
  margin-bottom: 0.5em }
 object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
 }
 /* Uncomment (and remove this text!) to get bold-faced definition list terms
 dl.docutils dt {
  font-weight: bold }
 */
 div.abstract {
  margin: 2em 5em }
 div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }
 div.admonition, div.attention, div.caution, div.danger, div.error,
 div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }
 div.admonition p.admonition-title, div.hint p.admonition-title,
 div.important p.admonition-title, div.note p.admonition-title,
 div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }
 div.attention p.admonition-title, div.caution p.admonition-title,
 div.danger p.admonition-title, div.error p.admonition-title,
 div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }
 /* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
 div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }
 div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
 */
 div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }
 div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }
 div.figure {
  margin-left: 2em ;
  margin-right: 2em }
 div.footer, div.header {
  clear: both;
  font-size: smaller }
 div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }
 div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }
 div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }
 div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }
 div.system-messages {
  margin: 5em }
 div.system-messages h1 {
  color: red }
 div.system-message {
  border: medium outset ;
  padding: 1em }
 div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }
 div.topic {
  margin: 2em }
 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }
 h1.title {
  text-align: center }
 h2.subtitle {
  text-align: center }
 hr.docutils {
  width: 75% }
 img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }
 img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }
 img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
 }
 table.align-center {
  margin-left: auto;
  margin-right: auto;
 }
 .align-left {
  text-align: left }
 .align-center {
  clear: both ;
  text-align: center }
 .align-right {
  text-align: right }
 /* reset inner alignment in figures */
 div.align-right {
  text-align: inherit }
 /* div.align-center * { */
 /*   text-align: left } */
 .align-top    {
  vertical-align: top }
 .align-middle {
  vertical-align: middle }
 .align-bottom {
  vertical-align: bottom }
 ol.simple, ul.simple {
  margin-bottom: 1em }
 ol.arabic {
  list-style: decimal }
 ol.loweralpha {
  list-style: lower-alpha }
 ol.upperalpha {
  list-style: upper-alpha }
 ol.lowerroman {
  list-style: lower-roman }
 ol.upperroman {
  list-style: upper-roman }
 p.attribution {
  text-align: right ;
  margin-left: 50% }
 p.caption {
  font-style: italic }
 p.credits {
  font-style: italic ;
  font-size: smaller }
 p.label {
  white-space: nowrap }
 p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }
 p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }
 p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }
 p.topic-title {
  font-weight: bold }
 pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }
 pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }
 pre.code .ln { color: grey; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
 pre.code .literal.string, code .literal.string { color: #0C5404 }
 pre.code .name.builtin, code .name.builtin { color: #352B84 }
 pre.code .deleted, code .deleted { background-color: #DEB0A1}
 pre.code .inserted, code .inserted { background-color: #A3D289}
 span.classifier {
  font-family: sans-serif ;
  font-style: oblique }
 span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }
 span.interpreted {
  font-family: sans-serif }
 span.option {
  white-space: nowrap }
 span.pre {
  white-space: pre }
 span.problematic {
  color: red }
 span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }
 table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }
 table.docinfo {
  margin: 2em 4em }
 table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }
 table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }
 table.docutils td, table.docutils th,
 table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }
 table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }
 /* "booktabs" style (no vertical lines) */
 table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
 }
 table.docutils.booktabs * {
  border: 0px;
 }
 table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
 }
 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }
 ul.auto-toc {
  list-style-type: none }
 </style>
 </head>
 <body>
 <div class="document" id="customizable-unsubscription-process-on-mass-mailing-emails">
 <h1 class="title">Customizable unsubscription process on mass mailing emails</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <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/11.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-11-0/social-11-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/11.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>
 </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>
 <div class="section" id="configuration">
 <h1><a class="toc-backref" href="#id1">Configuration</a></h1>
 <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>Mass Mailing &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>
 </div>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#id2">Usage</a></h1>
 <p>Once configured:</p>
 <ol class="arabic simple">
 <li>Go to <em>Mass Mailing &gt; Mailings &gt; Mass 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>Mass Mailing &gt; Mailings &gt; Unsubscriptions</em>.</li>
 </ol>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
 <ul class="simple">
 <li>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.</li>
 <li>This module replaces AJAX submission core implementation from the mailing
 list management form, because it is impossible to extend it. When
 <a class="reference external" href="https://github.com/odoo/odoo/pull/14386">https://github.com/odoo/odoo/pull/14386</a> 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 <tt class="docutils literal">website_mass_mailing</tt>.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
 <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:%2011.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>
 </div>
 <div class="section" id="credits">
 <h1><a class="toc-backref" href="#id5">Credits</a></h1>
 <div class="section" id="authors">
 <h2><a class="toc-backref" href="#id6">Authors</a></h2>
 <ul class="simple">
 <li>Tecnativa</li>
 </ul>
 </div>
 <div class="section" id="contributors">
 <h2><a class="toc-backref" href="#id7">Contributors</a></h2>
 <ul class="simple">
 <li>Rafael Blasco &lt;<a class="reference external" href="mailto:rafael.blasco&#64;tecnativa.com">rafael.blasco&#64;tecnativa.com</a>&gt;</li>
 <li>Antonio Espinosa &lt;<a class="reference external" href="mailto:antonio.espinosa&#64;tecnativa.com">antonio.espinosa&#64;tecnativa.com</a>&gt;</li>
 <li>Jairo Llopis &lt;<a class="reference external" href="mailto:jairo.llopis&#64;tecnativa.com">jairo.llopis&#64;tecnativa.com</a>&gt;</li>
 <li>David Vidal &lt;<a class="reference external" href="mailto:david.vidal&#64;tecnativa.com">david.vidal&#64;tecnativa.com</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
 <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/11.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>
 </div>
 </div>
 </div>
 </body>
 </html>