diff --git a/mail_tracking_mailgun/README.rst b/mail_tracking_mailgun/README.rst index 67eb4276..d3edb574 100644 --- a/mail_tracking_mailgun/README.rst +++ b/mail_tracking_mailgun/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ========================= Mail tracking for Mailgun ========================= +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/12.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-12-0/social-12-0-mail_tracking_mailgun + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/205/12.0 + :alt: Try me on Runbot + +|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 @@ -14,6 +33,11 @@ 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: + Configuration ============= @@ -65,10 +89,6 @@ 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. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/205/11.0 - Known issues / Roadmap ====================== @@ -77,39 +97,54 @@ Known issues / Roadmap Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smashing it by providing a detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Tecnativa + +Contributors +~~~~~~~~~~~~ + +* `Tecnativa `_: + + * Antonio Espinosa + * Carlos Dauden + * Pedro M. Baeza + * David Vidal + * Rafael Blasco + * Ernesto Tejeda + +Other credits +~~~~~~~~~~~~~ + Images ------ * Mailgun logo: `SVG Icon `_. -Contributors ------------- - -* Antonio Espinosa -* Carlos Dauden -* Pedro M. Baeza -* David Vidal -* Rafael Blasco +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_tracking_mailgun/__manifest__.py b/mail_tracking_mailgun/__manifest__.py index 36f3dc12..077d8b36 100644 --- a/mail_tracking_mailgun/__manifest__.py +++ b/mail_tracking_mailgun/__manifest__.py @@ -6,7 +6,7 @@ { "name": "Mail tracking for Mailgun", "summary": "Mail tracking and Mailgun webhooks integration", - "version": "11.0.1.1.2", + "version": "12.0.1.0.0", "category": "Social Network", "website": "https://github.com/OCA/social", "author": "Tecnativa, " diff --git a/mail_tracking_mailgun/models/ir_mail_server.py b/mail_tracking_mailgun/models/ir_mail_server.py index 055c8c1e..c1e73b61 100644 --- a/mail_tracking_mailgun/models/ir_mail_server.py +++ b/mail_tracking_mailgun/models/ir_mail_server.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 Tecnativa - Antonio Espinosa # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). diff --git a/mail_tracking_mailgun/models/mail_tracking_email.py b/mail_tracking_mailgun/models/mail_tracking_email.py index f3965572..45cfa6cf 100644 --- a/mail_tracking_mailgun/models/mail_tracking_email.py +++ b/mail_tracking_mailgun/models/mail_tracking_email.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 Tecnativa - Antonio Espinosa # Copyright 2017 Tecnativa - David Vidal # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). diff --git a/mail_tracking_mailgun/models/mail_tracking_event.py b/mail_tracking_mailgun/models/mail_tracking_event.py index 278210e9..201b4ac4 100644 --- a/mail_tracking_mailgun/models/mail_tracking_event.py +++ b/mail_tracking_mailgun/models/mail_tracking_event.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2017 Tecnativa - David Vidal # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). diff --git a/mail_tracking_mailgun/models/res_partner.py b/mail_tracking_mailgun/models/res_partner.py index ece4efe3..de3028dc 100644 --- a/mail_tracking_mailgun/models/res_partner.py +++ b/mail_tracking_mailgun/models/res_partner.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 Tecnativa - Antonio Espinosa # Copyright 2016 Tecnativa - Carlos Dauden # Copyright 2017 Tecnativa - Pedro M. Baeza diff --git a/mail_tracking_mailgun/readme/CONFIGURE.rst b/mail_tracking_mailgun/readme/CONFIGURE.rst new file mode 100644 index 00000000..59ade2d2 --- /dev/null +++ b/mail_tracking_mailgun/readme/CONFIGURE.rst @@ -0,0 +1,28 @@ +You must configure Mailgun webhooks in order to receive mail events: + +1. Got a Mailgun account and validate your sending domain. +2. Go to Webhook tab and configure the below URL for each event: + +.. code:: html + + https:///mail/tracking/all/ + +Replace '' with your Odoo install domain name +and '' with your database name. + +In order to validate Mailgun webhooks you have to configure the following system +parameters: + +- `mailgun.apikey`: You can find Mailgun api_key in your validated sending + domain. +- `mailgun.api_url`: It should be fine as it is, but it could change in the + future. +- `mailgun.domain`: In case your sending domain is different from the one + configured in `mail.catchall.domain`. +- `mailgun.validation_key`: If you want to be able to check mail address + validity you must config this parameter with your account Public Validation + Key. + +You can also config partner email autocheck with this system parameter: + +- `mailgun.auto_check_partner_email`: Set it to True. diff --git a/mail_tracking_mailgun/readme/CONTRIBUTORS.rst b/mail_tracking_mailgun/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..9e21d5b1 --- /dev/null +++ b/mail_tracking_mailgun/readme/CONTRIBUTORS.rst @@ -0,0 +1,8 @@ +* `Tecnativa `_: + + * Antonio Espinosa + * Carlos Dauden + * Pedro M. Baeza + * David Vidal + * Rafael Blasco + * Ernesto Tejeda diff --git a/mail_tracking_mailgun/readme/CREDITS.rst b/mail_tracking_mailgun/readme/CREDITS.rst new file mode 100644 index 00000000..add1584a --- /dev/null +++ b/mail_tracking_mailgun/readme/CREDITS.rst @@ -0,0 +1,4 @@ +Images +------ + +* Mailgun logo: `SVG Icon `_. diff --git a/mail_tracking_mailgun/readme/DESCRIPTION.rst b/mail_tracking_mailgun/readme/DESCRIPTION.rst new file mode 100644 index 00000000..c32fa117 --- /dev/null +++ b/mail_tracking_mailgun/readme/DESCRIPTION.rst @@ -0,0 +1,7 @@ +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. diff --git a/mail_tracking_mailgun/readme/ROADMAP.rst b/mail_tracking_mailgun/readme/ROADMAP.rst new file mode 100644 index 00000000..15538020 --- /dev/null +++ b/mail_tracking_mailgun/readme/ROADMAP.rst @@ -0,0 +1 @@ +* There's no support for more than one Mailgun mail server. diff --git a/mail_tracking_mailgun/readme/USAGE.rst b/mail_tracking_mailgun/readme/USAGE.rst new file mode 100644 index 00000000..225731a0 --- /dev/null +++ b/mail_tracking_mailgun/readme/USAGE.rst @@ -0,0 +1,15 @@ +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. diff --git a/mail_tracking_mailgun/static/description/index.html b/mail_tracking_mailgun/static/description/index.html new file mode 100644 index 00000000..cbc9fe2f --- /dev/null +++ b/mail_tracking_mailgun/static/description/index.html @@ -0,0 +1,501 @@ + + + + + + +Mail tracking for Mailgun + + + +
+

Mail tracking for Mailgun

+ + +

Beta License: AGPL-3 OCA/social Translate me on Weblate Try me on Runbot

+

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

+ +
+

Configuration

+

You must configure Mailgun webhooks in order to receive mail events:

+
    +
  1. Got a Mailgun account and validate your sending domain.
    2. +
  2. Go to Webhook tab and configure the below URL for each event:
    3. +
+
+https://<your_domain>/mail/tracking/all/<your_database>
+
+

Replace ‘<your_domain>’ with your Odoo install domain name +and ‘<your_database>’ with your database name.

+

In order to validate Mailgun webhooks you have to configure the following system +parameters:

+
    +
  • mailgun.apikey: You can find Mailgun api_key in your validated sending +domain.
    • +
  • mailgun.api_url: It should be fine as it is, but it could change in the +future.
    • +
  • mailgun.domain: In case your sending domain is different from the one +configured in mail.catchall.domain.
    • +
  • mailgun.validation_key: If you want to be able to check mail address +validity you must config this parameter with your account Public Validation +Key.
    • +
+

You can also config partner email autocheck with this system parameter:

+
    +
  • mailgun.auto_check_partner_email: Set it to True.
    • +
+
+
+

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.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Tecnativa
    • +
+
+
+

Contributors

+
    +
  • Tecnativa:
      +
    • Antonio Espinosa
      • +
    • Carlos Dauden
      • +
    • Pedro M. Baeza
      • +
    • David Vidal
      • +
    • Rafael Blasco
      • +
    • Ernesto Tejeda
      • +
    +
    • +
+
+
+

Other credits

+
+

Images

+ +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/mail_tracking_mailgun/tests/test_mailgun.py b/mail_tracking_mailgun/tests/test_mailgun.py index 7230ce93..5c3e5b59 100644 --- a/mail_tracking_mailgun/tests/test_mailgun.py +++ b/mail_tracking_mailgun/tests/test_mailgun.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2016 Tecnativa - Antonio Espinosa # Copyright 2017 Tecnativa - David Vidal # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).