Search 1.9 billion lines of Odoo code on GitHub
mail_tracking_mailgun
<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="mail-tracking-for-mailgun"></a>
<h2>Mail tracking for Mailgun</h2>
<p>This module integrates mail_tracking events with Mailgun webhooks.</p>
<p>Mailgun (<a class="reference external" href="https://www.mailgun.com/">https://www.mailgun.com/</a>) 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.</p>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>You must configure Mailgun webhooks in order to receive mail events:</p>
<ol class="arabic simple">
<li>Got a Mailgun account and validate your sending domain.</li>
<li>Go to Webhook tab and configure the below URL for each event:</li>
</ol>
<pre>
<code lang="html">https://<your_domain>/mail/tracking/all/<your_database></code>
</pre>
<p>Replace '<your_domain>' with your Odoo install domain name
and '<your_database>' with your database name.</p>
<p>In order to validate Mailgun webhooks you have to configure the following system
parameters:</p>
<ul class="simple">
<li><cite>mailgun.apikey</cite>: You can find Mailgun api_key in your validated sending
domain.</li>
<li><cite>mailgun.api_url</cite>: It should be fine as it is, but it could change in the
future.</li>
<li><cite>mailgun.domain</cite>: In case your sending domain is different from the one
configured in <cite>mail.catchall.domain</cite>.</li>
<li><cite>mailgun.validation_key</cite>: If you want to be able to check mail address
validity you must config this parameter with your account Public Validation
Key.</li>
</ul>
<a name="usage"></a>
<h3>Usage</h3>
<p>In your mail tracking status screens (explained on module <em>mail_tracking</em>), you will
see a more accurate information, like the 'Received' or 'Bounced' status, which are
not usually detected by normal SMTP servers.</p>
<p>It's also possible to make some checks to the partner's email addresses against the Mailgun API:</p>
<ul class="simple">
<li>Check if the partner's email is in Mailgun's bounced list.</li>
<li>Check the validity of the partner's mailbox.</li>
<li>Force the partner's email into Mailgun's bounced list or delete from it.</li>
</ul>
<p>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 <em>Check Mailgun</em>. It's important to note that tracking events have quite a
short lifespan, so after 24h they won't be recoverable.</p>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/205/9.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>There's no support for more than one Mailgun mail server.</li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>. 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.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Mailgun logo: <a class="reference external" href="http://seeklogo.com/mailgun-logo-273630.html">SVG Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Antonio Espinosa <<a class="reference external" href="mailto:antonio.espinosa@tecnativa.com">antonio.espinosa@tecnativa.com</a>></li>
<li>Carlos Dauden <<a class="reference external" href="mailto:carlos.dauden@tecnativa.com">carlos.dauden@tecnativa.com</a>></li>
<li>Pedro M. Baeza <<a class="reference external" href="mailto:pedro.baeza@tecnativa.com">pedro.baeza@tecnativa.com</a>></li>
<li>David Vidal <<a class="reference external" href="mailto:david.vidal@tecnativa.com">david.vidal@tecnativa.com</a>></li>
<li>Rafael Blasco <<a class="reference external" href="mailto:rafael.blasco@tecnativa.com">rafael.blasco@tecnativa.com</a>></li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>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.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>