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.

108 lines
3.2 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =========================
  5. Mail digest notifications
  6. =========================
  7. Features
  8. --------
  9. This module allows users/partners to:
  10. * select "digest" mode in their notification settings
  11. * with digest mode on select a frequency: "daily" or "weekly"
  12. * configure specific rules per message subtype (enabled/disabled)
  13. to receive or to not receive any email notification for a given subtype.
  14. The preference tab on user's form will look like:
  15. .. image:: ./images/preview.png
  16. Behavior
  17. --------
  18. When a partner with digest mode on is notified with a message or an email
  19. all the messages are collected inside a `mail.digest` container.
  20. A daily cron and a weekly cron will take care of creating a single email per each digest,
  21. which will be sent as a standard email.
  22. If the message has a specific subtype, all of this will work only
  23. if personal settings allow to receive notification for that specific subtype.
  24. Specifically:
  25. * no record for type: message passes
  26. * record disabled for type: message don't pass
  27. * record enabled for type: message pass
  28. NOTE: under the hood the digest notification logic excludes followers to be notified,
  29. since you really want to notify only mail.digest's partner.
  30. NOTE 2: Odoo's mail machinery has an option `force_send`
  31. to send the email immediately without waiting for the mail queue to be processed.
  32. When this option is used the email is sent right away
  33. and the message record is deleted right after.
  34. A typical use case is the reset password mail.
  35. We assume that if you use that option you really want the email to go out "now"
  36. so when `force_send` is used, digest machinery is completely bypassed.
  37. Global settings
  38. ---------------
  39. By default digest functionality is enabled for every message type ('email', 'comment', 'notification').
  40. You change this with the config param `mail_digest.enabled_message_types`
  41. whereas you can specify message types separated by comma.
  42. Known issues / Roadmap
  43. ======================
  44. * take full control of message and email template.
  45. Right now the notification message and the digest mail itself is wrapped inside Odoo mail template.
  46. We should be able to customize this easily.
  47. Bug Tracker
  48. ===========
  49. Bugs are tracked on `GitHub Issues
  50. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  51. check there if your issue has already been reported. If you spotted it first,
  52. help us smashing it by providing a detailed and welcomed feedback.
  53. Credits
  54. =======
  55. Contributors
  56. ------------
  57. * Simone Orsi <simone.orsi@camptocamp.com>
  58. Funders
  59. -------
  60. The development of this module has been financially supported by: `Fluxdock.io <https://fluxdock.io>`_
  61. Maintainer
  62. ----------
  63. .. image:: https://odoo-community.org/logo.png
  64. :alt: Odoo Community Association
  65. :target: https://odoo-community.org
  66. This module is maintained by the OCA.
  67. OCA, or the Odoo Community Association, is a nonprofit organization whose
  68. mission is to support the collaborative development of Odoo features and
  69. promote its widespread use.
  70. To contribute to this module, please visit https://odoo-community.org.