Skip to main content
License: AGPL-3

Mail tracking for Mailgun

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.

Configuration

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:

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.

Try me on Runbot

Known issues / Roadmap

  • There’s no support for more than one Mailgun mail server.

  • There’s no support for webhooks, only for legacy webhooks

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.

Credits

Images

Contributors

Maintainer

Odoo Community Association

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.

Release files for odoo11-addon-mail-tracking-mailgun 11.0.1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo11-addon-mail-tracking-mailgun 11.0.1.2.1
File Interpreter ABI Platform
odoo11_addon_mail_tracking_mailgun-11.0.1.2.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Release files / odoo11_addon_mail_tracking_mailgun-11.0.1.2.1-py2.py3-none-any.whl

Download URL odoo11_addon_mail_tracking_mailgun-11.0.1.2.1-py2.py3-none-any.whl
Size 95.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b0922d7efa7e4e42cc3d9ee979fe981bc32064980487bd4244809d89ddbeb161
BLAKE2b-256 checksum
How to use checksums
b0a56d7be5adf62a90cfca6f92ebbaed2d03ec698aa830d26642b9b42698ccf4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/30.4.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page