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.

146 lines
4.7 KiB

  1. ==============
  2. Email tracking
  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/12.0/mail_tracking
  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-12-0/social-12-0-mail_tracking
  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/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module shows email notification tracking status for any messages in
  25. mail thread (chatter). Each notified partner will have an intuitive icon just
  26. right to his name.
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Installation
  31. ============
  32. If you're using a multi-database installation (with or without dbfilter option)
  33. where /web/databse/selector returns a list of more than one database, then
  34. you need to add ``mail_tracking`` addon to wide load addons list
  35. (by default, only ``web`` addon), setting ``--load`` option.
  36. For example, ``--load=web,mail_tracking``
  37. Usage
  38. =====
  39. When user sends a message in mail_thread (chatter), for instance in partner
  40. form, then an email tracking is created for each email notification. Then a
  41. status icon will appear just right to name of notified partner.
  42. These are all available status icons:
  43. .. |sent| image:: mail_tracking/static/src/img/sent.png
  44. :width: 10px
  45. .. |delivered| image:: mail_tracking/static/src/img/delivered.png
  46. :width: 15px
  47. .. |opened| image:: mail_tracking/static/src/img/opened.png
  48. :width: 15px
  49. .. |error| image:: mail_tracking/static/src/img/error.png
  50. :width: 10px
  51. .. |waiting| image:: mail_tracking/static/src/img/waiting.png
  52. :width: 10px
  53. .. |unknown| image:: mail_tracking/static/src/img/unknown.png
  54. :width: 10px
  55. |unknown| **Unknown**: No email tracking info available. Maybe this notified partner has 'Receive Inbox Notifications by Email' == 'Never'
  56. |waiting| **Waiting**: Waiting to be sent
  57. |error| **Error**: Error while sending
  58. |sent| **Sent**: Sent to SMTP server configured
  59. |delivered| **Delivered**: Delivered to final MX server
  60. |opened| **Opened**: Opened by partner
  61. If you want to see all tracking emails and events you can go to
  62. * Settings > Technical > Email > Tracking emails
  63. * Settings > Technical > Email > Tracking events
  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:%20mail_tracking%0Aversion:%2012.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. * `Tecnativa <https://www.tecnativa.com>`_:
  79. * Pedro M. Baeza
  80. * Antonio Espinosa
  81. * David Vidal
  82. * Ernesto Tejeda
  83. * Rafael Blasco
  84. Other credits
  85. ~~~~~~~~~~~~~
  86. Images
  87. ------
  88. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  89. * Thanks to `LlubNek <https://openclipart.org/user-detail/LlubNek>`_ and `Openclipart
  90. <https://openclipart.org>`_ for `the icon
  91. <https://openclipart.org/detail/19342/open-envelope>`_.
  92. Maintainers
  93. ~~~~~~~~~~~
  94. This module is maintained by the OCA.
  95. .. image:: https://odoo-community.org/logo.png
  96. :alt: Odoo Community Association
  97. :target: https://odoo-community.org
  98. OCA, or the Odoo Community Association, is a nonprofit organization whose
  99. mission is to support the collaborative development of Odoo features and
  100. promote its widespread use.
  101. This module is part of the `OCA/social <https://github.com/OCA/social/tree/12.0/mail_tracking>`_ project on GitHub.
  102. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.