mirror of https://github.com/OCA/social.git
161 lines
5.4 KiB
ReStructuredText
161 lines
5.4 KiB
ReStructuredText
=========================
|
|
Mail tracking for Mailgun
|
|
=========================
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:12909cda59da25c0c1ae3f30c93b078e967e63d0abc0aa75e9d05c5f0994f435
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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%2Fsocial-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/social/tree/17.0/mail_tracking_mailgun
|
|
:alt: OCA/social
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_tracking_mailgun
|
|
: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/social&target_branch=17.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module integrates mail_tracking events with Mailgun webhooks.
|
|
|
|
`Mailgun <https://www.mailgun.com>`__ is a service that provides an
|
|
e-mail sending infrastructure through an SMTP server or via API. You can
|
|
also query that API for seeing statistics of your sent e-mails, or
|
|
provide hooks that processes the status changes in real time, which is
|
|
the function used here.
|
|
|
|
**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_mailgun`` addon to wide
|
|
load addons list (by default, only ``web`` addon), setting ``--load``
|
|
option.
|
|
|
|
Example: ``--load=web,mail_tracking,mail_tracking_mailgun``
|
|
|
|
Configuration
|
|
=============
|
|
|
|
To configure this module, you need to:
|
|
|
|
1. Go to Mailgun, create an account and validate your sending domain.
|
|
2. Go back to Odoo.
|
|
3. Go to *Settings > General Settings > Discuss > Enable mail tracking
|
|
with Mailgun*.
|
|
4. Fill all the values. The only one required is the API key.
|
|
5. Optionally click *Unregister Mailgun webhooks* and accept.
|
|
6. Click *Register Mailgun webhooks*.
|
|
|
|
You can also config timeout for mailgun with this system parameter:
|
|
|
|
- ``mailgun.timeout``: Set it to a number of seconds.
|
|
|
|
Usage
|
|
=====
|
|
|
|
In your mail tracking status screens (explained on module
|
|
*mail_tracking*), you will see a more accurate information, like the
|
|
'Received' or 'Bounced' status, which are not usually detected by normal
|
|
SMTP servers.
|
|
|
|
It's also possible to make some checks to the partner's email addresses
|
|
against the Mailgun API:
|
|
|
|
- Check if the partner's email is in Mailgun's bounced list.
|
|
- Check the validity of the partner's mailbox.
|
|
- Force the partner's email into Mailgun's bounced list or delete from
|
|
it.
|
|
|
|
It's also possible to manually check a message mailgun tracking when the
|
|
webhook couldn't be captured. For that, go to that message tracking
|
|
form, press the button *Check Mailgun*. It's important to note that
|
|
tracking events have quite a short lifespan, so after 24h they won't be
|
|
recoverable.
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
- There's no support for more than one Mailgun mail server.
|
|
- Automate more webhook registration. It would be nice to not have to
|
|
click the "Unregister Mailgun webhooks" and "Register Mailgun
|
|
webhooks" when setting up Mailgun in Odoo. However, it doesn't come
|
|
without its `conceptual
|
|
complexities <https://github.com/OCA/social/pull/787#discussion_r734275262>`__.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/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/social/issues/new?body=module:%20mail_tracking_mailgun%0Aversion:%2017.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>`__:
|
|
|
|
- Antonio Espinosa
|
|
- Carlos Dauden
|
|
- Pedro M. Baeza
|
|
- David Vidal
|
|
- Rafael Blasco
|
|
- Ernesto Tejeda
|
|
- Jairo Llopis
|
|
- Carlos Roca
|
|
|
|
Other credits
|
|
-------------
|
|
|
|
Images
|
|
~~~~~~
|
|
|
|
- Mailgun logo: `SVG
|
|
Icon <http://seeklogo.com/mailgun-logo-273630.html>`__.
|
|
|
|
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/social <https://github.com/OCA/social/tree/17.0/mail_tracking_mailgun>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|