~opencrea/+junk/aprobio

« back to all changes in this revision

Viewing changes to mail_tracking/README.rst

  • Committer: joannes
  • Date: 2017-05-17 09:40:42 UTC
  • Revision ID: joannes@debian-20170517094042-47q3j6on72w2h1il
community module

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
=============
 
6
Mail tracking
 
7
=============
 
8
 
 
9
This module shows email notification tracking status for any messages in
 
10
mail thread (chatter). Each notified partner will have an intuitive icon just
 
11
right to his name.
 
12
 
 
13
 
 
14
Installation
 
15
============
 
16
 
 
17
If you're using a multi-database installation (with or without dbfilter option)
 
18
where /web/databse/selector returns a list of more than one database, then
 
19
you need to add ``mail_tracking`` addon to wide load addons list
 
20
(by default, only ``web`` addon), setting ``--load`` option.
 
21
For example, ``--load=web,mail_tracking``
 
22
 
 
23
 
 
24
Usage
 
25
=====
 
26
 
 
27
When user sends a message in mail_thread (chatter), for instance in partner
 
28
form, then an email tracking is created for each email notification. Then a
 
29
status icon will appear just right to name of notified partner.
 
30
 
 
31
These are all available status icons:
 
32
 
 
33
.. |sent| image:: mail_tracking/static/src/img/sent.png
 
34
   :width: 10px
 
35
 
 
36
.. |delivered| image:: mail_tracking/static/src/img/delivered.png
 
37
   :width: 15px
 
38
 
 
39
.. |opened| image:: mail_tracking/static/src/img/opened.png
 
40
   :width: 15px
 
41
 
 
42
.. |error| image:: mail_tracking/static/src/img/error.png
 
43
   :width: 10px
 
44
 
 
45
.. |waiting| image:: mail_tracking/static/src/img/waiting.png
 
46
   :width: 10px
 
47
 
 
48
.. |unknown| image:: mail_tracking/static/src/img/unknown.png
 
49
   :width: 10px
 
50
 
 
51
|unknown|  **Unknown**: No email tracking info available. Maybe this notified partner has 'Receive Inbox Notifications by Email' == 'Never'
 
52
 
 
53
|waiting|    **Waiting**: Waiting to be sent
 
54
 
 
55
|error|    **Error**: Error while sending
 
56
 
 
57
|sent|    **Sent**: Sent to SMTP server configured
 
58
 
 
59
|delivered|    **Delivered**: Delivered to final MX server
 
60
 
 
61
|opened|  **Opened**: Opened by partner
 
62
 
 
63
 
 
64
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
 
65
   :alt: Try me on Runbot
 
66
   :target: https://runbot.odoo-community.org/runbot/205/10.0
 
67
 
 
68
If you want to see all tracking emails and events you can go to
 
69
 
 
70
* Settings > Technical > Email > Tracking emails
 
71
* Settings > Technical > Email > Tracking events
 
72
 
 
73
 
 
74
Bug Tracker
 
75
===========
 
76
 
 
77
Bugs are tracked on `GitHub Issues
 
78
<https://github.com/OCA/social/issues>`_. In case of trouble, please
 
79
check there if your issue has already been reported. If you spotted it first,
 
80
help us smashing it by providing a detailed and welcomed feedback.
 
81
 
 
82
Credits
 
83
=======
 
84
 
 
85
Images
 
86
------
 
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
 
 
93
Contributors
 
94
------------
 
95
 
 
96
* Pedro M. Baeza <pedro.baeza@tecnativa.com>
 
97
* Antonio Espinosa <antonio.espinosa@tecnativa.com>
 
98
 
 
99
Maintainer
 
100
----------
 
101
 
 
102
.. image:: https://odoo-community.org/logo.png
 
103
   :alt: Odoo Community Association
 
104
   :target: https://odoo-community.org
 
105
 
 
106
This module is maintained by the OCA.
 
107
 
 
108
OCA, or the Odoo Community Association, is a nonprofit organization whose
 
109
mission is to support the collaborative development of Odoo features and
 
110
promote its widespread use.
 
111
 
 
112
To contribute to this module, please visit https://odoo-community.org.