You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
4.6 KiB

  1. ==========================================================
  2. Customizable unsubscription process on mass mailing emails
  3. ==========================================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
  15. :target: https://github.com/OCA/social/tree/11.0/mass_mailing_custom_unsubscribe
  16. :alt: OCA/social
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/social-11-0/social-11-0-mass_mailing_custom_unsubscribe
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/205/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This addon extends the unsubscription form to let you:
  25. - Choose which mailing lists are not cross-unsubscriptable when unsubscribing
  26. from a different one.
  27. - Know why and when a contact has been subscribed or unsubscribed from a
  28. mass mailing.
  29. - Provide proof on why you are sending mass mailings to a given contact, as
  30. required by the GDPR in Europe.
  31. **Table of contents**
  32. .. contents::
  33. :local:
  34. Configuration
  35. =============
  36. You can customize what reasons will be displayed to your unsubscriptors when
  37. they are going to unsubscribe. To do it:
  38. #. Go to *Mass Mailing > Configuration > Unsubscription Reasons*.
  39. #. Create / edit / remove / sort as usual.
  40. #. If *Details required* is enabled, they will have to fill a text area to
  41. continue.
  42. Usage
  43. =====
  44. Once configured:
  45. #. Go to *Mass Mailing > Mailings > Mass Mailings > Create*.
  46. #. Edit your mass mailing at wish, but remember to add a snippet from
  47. *Footers*, so people have an *Unsubscribe* link.
  48. #. Send it.
  49. #. If somebody gets unsubscribed, you will see logs about that under
  50. *Mass Mailing > Mailings > Unsubscriptions*.
  51. Known issues / Roadmap
  52. ======================
  53. * As version 11 has introduced a new relation type between mailing lists and
  54. contacts that has multiple usability issues that are being reworked by Odoo
  55. to land in version 12, this module falls back to the version 10 behaviour in
  56. which one contact belonged to just one list.
  57. * This module replaces AJAX submission core implementation from the mailing
  58. list management form, because it is impossible to extend it. When
  59. https://github.com/odoo/odoo/pull/14386 gets merged (which upstreams most
  60. needed changes), this addon will need a refactoring (mostly removing
  61. duplicated functionality and depending on it instead of replacing it). In the
  62. mean time, there is a little chance that this introduces some
  63. incompatibilities with other addons that depend on ``website_mass_mailing``.
  64. Bug Tracker
  65. ===========
  66. Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
  67. In case of trouble, please check there if your issue has already been reported.
  68. If you spotted it first, help us smashing it by providing a detailed and welcomed
  69. `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**>`_.
  70. Do not contact contributors directly about support or help with technical issues.
  71. Credits
  72. =======
  73. Authors
  74. ~~~~~~~
  75. * Tecnativa
  76. Contributors
  77. ~~~~~~~~~~~~
  78. * Rafael Blasco <rafael.blasco@tecnativa.com>
  79. * Antonio Espinosa <antonio.espinosa@tecnativa.com>
  80. * Jairo Llopis <jairo.llopis@tecnativa.com>
  81. * David Vidal <david.vidal@tecnativa.com>
  82. Maintainers
  83. ~~~~~~~~~~~
  84. This module is maintained by the OCA.
  85. .. image:: https://odoo-community.org/logo.png
  86. :alt: Odoo Community Association
  87. :target: https://odoo-community.org
  88. OCA, or the Odoo Community Association, is a nonprofit organization whose
  89. mission is to support the collaborative development of Odoo features and
  90. promote its widespread use.
  91. This module is part of the `OCA/social <https://github.com/OCA/social/tree/11.0/mass_mailing_custom_unsubscribe>`_ project on GitHub.
  92. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.