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.

114 lines
3.7 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 tracking for Mailgun
  6. =========================
  7. This module integrates mail_tracking events with Mailgun webhooks.
  8. Mailgun (https://www.mailgun.com/) is a service that provides an e-mail
  9. sending infrastructure through an SMTP server or via API. You can also
  10. query that API for seeing statistics of your sent e-mails, or provide
  11. hooks that processes the status changes in real time, which is the
  12. function used here.
  13. Configuration
  14. =============
  15. You must configure Mailgun webhooks in order to receive mail events:
  16. 1. Got a Mailgun account and validate your sending domain.
  17. 2. Go to Webhook tab and configure the below URL for each event:
  18. .. code:: html
  19. https://<your_domain>/mail/tracking/all/<your_database>
  20. Replace '<your_domain>' with your Odoo install domain name
  21. and '<your_database>' with your database name.
  22. In order to validate Mailgun webhooks you have to configure the following system
  23. parameters:
  24. - `mailgun.apikey`: You can find Mailgun api_key in your validated sending
  25. domain.
  26. - `mailgun.api_url`: It should be fine as it is, but it could change in the
  27. future.
  28. - `mailgun.domain`: In case your sending domain is different from the one
  29. configured in `mail.catchall.domain`.
  30. - `mailgun.validation_key`: If you want to be able to check mail address
  31. validity you must config this parameter with your account Public Validation
  32. Key.
  33. You can also config partner email autocheck with this system parameter:
  34. - `mailgun.auto_check_partner_email`: Set it to True.
  35. Usage
  36. =====
  37. In your mail tracking status screens (explained on module *mail_tracking*), you will
  38. see a more accurate information, like the 'Received' or 'Bounced' status, which are
  39. not usually detected by normal SMTP servers.
  40. It's also possible to make some checks to the partner's email addresses against the Mailgun API:
  41. - Check if the partner's email is in Mailgun's bounced list.
  42. - Check the validity of the partner's mailbox.
  43. - Force the partner's email into Mailgun's bounced list or delete from it.
  44. It's also possible to manually check a message mailgun tracking when the webhook
  45. couldn't be captured. For that, go to that message tracking form, press the
  46. button *Check Mailgun*. It's important to note that tracking events have quite a
  47. short lifespan, so after 24h they won't be recoverable.
  48. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  49. :alt: Try me on Runbot
  50. :target: https://runbot.odoo-community.org/runbot/205/9.0
  51. Known issues / Roadmap
  52. ======================
  53. * There's no support for more than one Mailgun mail server.
  54. Bug Tracker
  55. ===========
  56. Bugs are tracked on `GitHub Issues
  57. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  58. check there if your issue has already been reported. If you spotted it first,
  59. help us smashing it by providing a detailed and welcomed feedback.
  60. Credits
  61. =======
  62. Images
  63. ------
  64. * Mailgun logo: `SVG Icon <http://seeklogo.com/mailgun-logo-273630.html>`_.
  65. Contributors
  66. ------------
  67. * Antonio Espinosa <antonio.espinosa@tecnativa.com>
  68. * Carlos Dauden <carlos.dauden@tecnativa.com>
  69. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  70. * David Vidal <david.vidal@tecnativa.com>
  71. * Rafael Blasco <rafael.blasco@tecnativa.com>
  72. Maintainer
  73. ----------
  74. .. image:: https://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: https://odoo-community.org
  77. This module is maintained by the OCA.
  78. OCA, or the Odoo Community Association, is a nonprofit organization whose
  79. mission is to support the collaborative development of Odoo features and
  80. promote its widespread use.
  81. To contribute to this module, please visit https://odoo-community.org.