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.

92 lines
2.9 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. ==========================================================
  4. Customizable unsubscription process on mass mailing emails
  5. ==========================================================
  6. With this module you can set a custom unsubscribe link appended at the bottom
  7. of mass mailing emails.
  8. Configuration
  9. =============
  10. To configure unsubscribe label go to *Settings > Technical > Parameters >
  11. System parameters* and add a ``mass_mailing.unsubscribe.label`` parameter
  12. with HTML to set at the bottom of mass emailing emails. Including ``%(url)s``
  13. variable where unsubscribe link.
  14. For example::
  15. <small>You can unsubscribe <a href="%(url)s">here</a></small>
  16. Additionally, you can disable this link if you set this parameter to ``False``.
  17. If this parameter (``mass_mailing.unsubscribe.label``) does not exist, the
  18. default 'Click to unsubscribe' link will appear, with the advantage that it is
  19. translatable via *Settings > Translations > Application Terms > Translated
  20. terms*.
  21. Also your unsubscriptors will recieve a beautier goodbye page. You can
  22. customize it clicking here **after installing the module**:
  23. * `Unsubscription successful </page/mass_mail_unsubscription_success>`_.
  24. * `Unsubscription failed </page/mass_mail_unsubscription_failure>`_.
  25. Usage
  26. =====
  27. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  28. :alt: Try me on Runbot
  29. :target: https://runbot.odoo-community.org/runbot/205/8.0
  30. Known issues / Roadmap
  31. ======================
  32. * This custom HTML is not translatable, so as a suggestion, you can define
  33. the same text in several languages in several lines.
  34. For example:
  35. .. code:: html
  36. <small>[EN] You can unsubscribe <a href="%(url)s">here</a></small><br/>
  37. <small>[ES] Puedes darte de baja <a href="%(url)s">aquí</a></small>
  38. Bug Tracker
  39. ===========
  40. Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
  41. In case of trouble, please check there if your issue has already been reported.
  42. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  43. `here <https://github.com/OCA/social/issues/new?body=module:%20mass_mailing_custom_unsubscribe%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  44. Credits
  45. =======
  46. Contributors
  47. ------------
  48. * Rafael Blasco <rafabn@antiun.com>
  49. * Antonio Espinosa <antonioea@antiun.com>
  50. * Jairo Llopis <yajo.sk8@gmail.com>
  51. Maintainer
  52. ----------
  53. .. image:: https://odoo-community.org/logo.png
  54. :alt: Odoo Community Association
  55. :target: https://odoo-community.org
  56. This module is maintained by the OCA.
  57. OCA, or the Odoo Community Association, is a nonprofit organization whose
  58. mission is to support the collaborative development of Odoo features and
  59. promote its widespread use.
  60. To contribute to this module, please visit http://odoo-community.org.