==============
Email tracking
==============
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:f915d20c24d475060f6e72e87e86d5ea527aeb8f71841bd39b080200eecd6435
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmail-lightgray.png?logo=github
:target: https://github.com/OCA/mail/tree/18.0/mail_tracking
:alt: OCA/mail
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/mail-18-0/mail-18-0-mail_tracking
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/mail&target_branch=18.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module shows email notification tracking status for any messages in
mail thread (chatter). Each notified partner will have an intuitive icon
just right to his name.
**Table of contents**
.. contents::
:local:
Installation
============
If you're using a multi-database installation (with or without dbfilter
option) where /web/databse/selector returns a list of more than one
database, then you need to add ``mail_tracking`` addon to wide load
addons list (by default, only ``web`` addon), setting ``--load`` option.
For example, ``--load=web,mail,mail_tracking``
Configuration
=============
As there can be scenarios where sending a tracking img in the email body
is not desired, there is a global system parameter
"mail_tracking.tracking_img_disabled" that can be set to True to remove
the tracking img from all outgoing emails. Note that the **Opened**
status will not be available in this case.
Usage
=====
When user sends a message in mail_thread (chatter), for instance in
partner form, then an email tracking is created for each email
notification. Then a status icon will appear just right to name of
notified partner.
These are all available status icons:
|unknown| **Unknown**: No email tracking info available. Maybe this
notified partner has 'Receive Inbox Notifications by Email' == 'Never'
|waiting| **Waiting**: Waiting to be sent
|error| **Error**: Error while sending
|sent| **Sent**: Sent to SMTP server configured
|delivered| **Delivered**: Delivered to final MX server
|opened| **Opened**: Opened by partner
|cc| **Cc**: It's a Carbon-Copy recipient. Can't know the status so is
'Unknown'
|noemail| **No Email**: The partner doesn't have a defined email
|anonuser| **No Partner**: The recipient doesn't have a defined partner
If you want to see all tracking emails and events you can go to
- Settings > Technical > Email > Tracking emails
- Settings > Technical > Email > Tracking events
When the message generates an 'error' status, it will apear on discuss
'Failed' channel. Any view with chatter can show the failed messages
too.
- Discuss
|image|
- Chatter
|image1|
You can use "Failed sent messages" filter present in all views to show
records with messages in failed status and that needs an user action.
- Filter
|image2|
.. |unknown| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/unknown.png
.. |waiting| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/waiting.png
.. |error| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/error.png
.. |sent| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/sent.png
.. |delivered| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/delivered.png
.. |opened| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/opened.png
.. |cc| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/cc.png
.. |noemail| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/no_email.png
.. |anonuser| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/anon_user.png
.. |image| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_discuss.png
.. |image1| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_widget.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_filter.png
Known issues / Roadmap
======================
- Integrate with the core ``mail.notification`` model as it overlaps
with what the ``mail.tracking`` model does. We could add the existing
features on top of that model and save lots of code lines.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/mail/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/mail/issues/new?body=module:%20mail_tracking%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
-------
* Tecnativa
Contributors
------------
- `Tecnativa <https://www.tecnativa.com>`__:
- Pedro M. Baeza
- Antonio Espinosa
- David Vidal
- Ernesto Tejeda
- Rafael Blasco
- Alexandre Díaz
- `Eezee-IT <https://www.eezee-it.com>`__:
- Asma Elferkhsi
- `Vauxoo <https://www.vauxoo.com>`__:
- Agustín Payen Sandoval
- `Trobz <https://www.trobz.com>`__:
- Tris Doan
Other credits
-------------
The migration of this module from 17.0 to 18.0 was financially supported
by Camptocamp.
Maintainers
-----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
This module is part of the `OCA/mail <https://github.com/OCA/mail/tree/18.0/mail_tracking>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/mail",
"name": "odoo-addon-mail-tracking",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Tecnativa, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "==============\nEmail tracking\n==============\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:f915d20c24d475060f6e72e87e86d5ea527aeb8f71841bd39b080200eecd6435\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmail-lightgray.png?logo=github\n :target: https://github.com/OCA/mail/tree/18.0/mail_tracking\n :alt: OCA/mail\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/mail-18-0/mail-18-0-mail_tracking\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/mail&target_branch=18.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module shows email notification tracking status for any messages in\nmail thread (chatter). Each notified partner will have an intuitive icon\njust right to his name.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nInstallation\n============\n\nIf you're using a multi-database installation (with or without dbfilter\noption) where /web/databse/selector returns a list of more than one\ndatabase, then you need to add ``mail_tracking`` addon to wide load\naddons list (by default, only ``web`` addon), setting ``--load`` option.\nFor example, ``--load=web,mail,mail_tracking``\n\nConfiguration\n=============\n\nAs there can be scenarios where sending a tracking img in the email body\nis not desired, there is a global system parameter\n\"mail_tracking.tracking_img_disabled\" that can be set to True to remove\nthe tracking img from all outgoing emails. Note that the **Opened**\nstatus will not be available in this case.\n\nUsage\n=====\n\nWhen user sends a message in mail_thread (chatter), for instance in\npartner form, then an email tracking is created for each email\nnotification. Then a status icon will appear just right to name of\nnotified partner.\n\nThese are all available status icons:\n\n|unknown| **Unknown**: No email tracking info available. Maybe this\nnotified partner has 'Receive Inbox Notifications by Email' == 'Never'\n\n|waiting| **Waiting**: Waiting to be sent\n\n|error| **Error**: Error while sending\n\n|sent| **Sent**: Sent to SMTP server configured\n\n|delivered| **Delivered**: Delivered to final MX server\n\n|opened| **Opened**: Opened by partner\n\n|cc| **Cc**: It's a Carbon-Copy recipient. Can't know the status so is\n'Unknown'\n\n|noemail| **No Email**: The partner doesn't have a defined email\n\n|anonuser| **No Partner**: The recipient doesn't have a defined partner\n\nIf you want to see all tracking emails and events you can go to\n\n- Settings > Technical > Email > Tracking emails\n- Settings > Technical > Email > Tracking events\n\nWhen the message generates an 'error' status, it will apear on discuss\n'Failed' channel. Any view with chatter can show the failed messages\ntoo.\n\n- Discuss\n\n |image|\n\n- Chatter\n\n |image1|\n\nYou can use \"Failed sent messages\" filter present in all views to show\nrecords with messages in failed status and that needs an user action.\n\n- Filter\n\n |image2|\n\n.. |unknown| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/unknown.png\n.. |waiting| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/waiting.png\n.. |error| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/error.png\n.. |sent| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/sent.png\n.. |delivered| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/delivered.png\n.. |opened| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/opened.png\n.. |cc| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/cc.png\n.. |noemail| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/no_email.png\n.. |anonuser| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/src/img/anon_user.png\n.. |image| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_discuss.png\n.. |image1| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_widget.png\n.. |image2| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_tracking/static/img/failed_message_filter.png\n\nKnown issues / Roadmap\n======================\n\n- Integrate with the core ``mail.notification`` model as it overlaps\n with what the ``mail.tracking`` model does. We could add the existing\n features on top of that model and save lots of code lines.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/mail/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/mail/issues/new?body=module:%20mail_tracking%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Tecnativa\n\nContributors\n------------\n\n- `Tecnativa <https://www.tecnativa.com>`__:\n\n - Pedro M. Baeza\n - Antonio Espinosa\n - David Vidal\n - Ernesto Tejeda\n - Rafael Blasco\n - Alexandre D\u00edaz\n\n- `Eezee-IT <https://www.eezee-it.com>`__:\n\n - Asma Elferkhsi\n\n- `Vauxoo <https://www.vauxoo.com>`__:\n\n - Agust\u00edn Payen Sandoval\n\n- `Trobz <https://www.trobz.com>`__:\n\n - Tris Doan\n\nOther credits\n-------------\n\nThe migration of this module from 17.0 to 18.0 was financially supported\nby Camptocamp.\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/mail <https://github.com/OCA/mail/tree/18.0/mail_tracking>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Email tracking system for all mails sent",
"version": "18.0.1.0.0.7",
"project_urls": {
"Homepage": "https://github.com/OCA/mail"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15f826d4e421c6cb228b4399bb203f7e8ec659b7637117835462c886b6d2a4c6",
"md5": "4bb24747b653f62b7552d41622d14619",
"sha256": "21d6de4a08768fdbe08accde86cc41403f440dde9661fa4fde394a7a88907a20"
},
"downloads": -1,
"filename": "odoo_addon_mail_tracking-18.0.1.0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bb24747b653f62b7552d41622d14619",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 535816,
"upload_time": "2025-01-16T03:07:40",
"upload_time_iso_8601": "2025-01-16T03:07:40.362451Z",
"url": "https://files.pythonhosted.org/packages/15/f8/26d4e421c6cb228b4399bb203f7e8ec659b7637117835462c886b6d2a4c6/odoo_addon_mail_tracking-18.0.1.0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 03:07:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "mail",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "premailer",
"specs": []
}
],
"lcname": "odoo-addon-mail-tracking"
}
JSON
