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.

86 lines
2.5 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 save Mailgun api_key in
  23. a system parameter named 'mailgun.apikey'. You can find Mailgun api_key in your
  24. validated sending domain.
  25. Usage
  26. =====
  27. In your mail tracking status screens (explained on module *mail_tracking*), you will
  28. see a more accurate information, like the 'Received' or 'Bounced' status, which are
  29. not usually detected by normal SMTP servers.
  30. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  31. :alt: Try me on Runbot
  32. :target: https://runbot.odoo-community.org/runbot/205/8.0
  33. Known issues / Roadmap
  34. ======================
  35. * There's no support for more than one Mailgun mail server.
  36. Bug Tracker
  37. ===========
  38. Bugs are tracked on `GitHub Issues
  39. <https://github.com/OCA/social/issues>`_. In case of trouble, please
  40. check there if your issue has already been reported. If you spotted it first,
  41. help us smashing it by providing a detailed and welcomed feedback.
  42. Credits
  43. =======
  44. Images
  45. ------
  46. * Mailgun logo: `SVG Icon <http://seeklogo.com/mailgun-logo-273630.html>`_.
  47. Contributors
  48. ------------
  49. * Antonio Espinosa <antonio.espinosa@tecnativa.com>
  50. Maintainer
  51. ----------
  52. .. image:: https://odoo-community.org/logo.png
  53. :alt: Odoo Community Association
  54. :target: https://odoo-community.org
  55. This module is maintained by the OCA.
  56. OCA, or the Odoo Community Association, is a nonprofit organization whose
  57. mission is to support the collaborative development of Odoo features and
  58. promote its widespread use.
  59. To contribute to this module, please visit https://odoo-community.org.