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.

104 lines
3.7 KiB

  1. =================
  2. Mail Browser View
  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/mail_browser_view
  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-mail_browser_view
  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 module enables you to add a link in your mail templates,
  25. so the users can view the resulting email in the browser in case
  26. they are badly displayed in their clients.
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Configuration
  31. =============
  32. You can configure an expiration time (in hours) by going to
  33. *Settings > Technical > System Parameters*
  34. and changing the value for `mail_browser_view.token_expiration_hours`.
  35. Any zero or negative values will disable the token expiration.
  36. Default value is 720 hours (1 month).
  37. Usage
  38. =====
  39. Upon module installation, a secure token will be generated for each mail,
  40. allowing it to be reached *via* a constructed URL.
  41. You can then put the following placeholder::
  42. <a href="#" class="view_in_browser_url">View this mail in browser</a>
  43. anywhere in your mail templates (of course, the link text can be changed).
  44. If you use templates not managed through Odoo editor, it is strongly advised
  45. to use the `mail_inline_style` module so the styles do not get messed up.
  46. Be aware that this feature will not work for templates
  47. having "Auto-Delete" value set to `True`.
  48. To avoid any unwanted 404 errors, all the placeholders within such templates
  49. will be removed automatically in the generated mails.
  50. Bug Tracker
  51. ===========
  52. Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
  53. In case of trouble, please check there if your issue has already been reported.
  54. If you spotted it first, help us smashing it by providing a detailed and welcomed
  55. `feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_browser_view%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  56. Do not contact contributors directly about support or help with technical issues.
  57. Credits
  58. =======
  59. Authors
  60. ~~~~~~~
  61. * Camptocamp
  62. Contributors
  63. ~~~~~~~~~~~~
  64. * Simone Orsi <simone.orsi@camptocamp.com>
  65. * Patrick Tombez <patrick.tombez@camptocamp.com>
  66. Maintainers
  67. ~~~~~~~~~~~
  68. This module is maintained by the OCA.
  69. .. image:: https://odoo-community.org/logo.png
  70. :alt: Odoo Community Association
  71. :target: https://odoo-community.org
  72. OCA, or the Odoo Community Association, is a nonprofit organization whose
  73. mission is to support the collaborative development of Odoo features and
  74. promote its widespread use.
  75. This module is part of the `OCA/social <https://github.com/OCA/social/tree/11.0/mail_browser_view>`_ project on GitHub.
  76. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.