Search 1.9 billion lines of Odoo code on GitHub

mail_tracking_mandrill

Author: Compassion CH, Odoo Community Association (OCA)
License: AGPL-3
Branch: 12.0-mandrill
Repository: CompassionCH/social
Dependencies: mail_tracking
Languages: Python (580, 90.9%), and reStructuredText (58, 9.1%)

<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg"> <a name="mandrill-mail-tracking"></a> <h2>Mandrill Mail Tracking</h2> <p>This module integrates <a class="reference external" href="https://mailchimp.com/features/transactional-email/">Mandrill</a> (now known as Transactional-Email) with Odoo. E-mails sent through Mandrill will be tracked using Mandrill Webhook Events.</p> <a name="installation"></a> <h3>Installation</h3> <p>In its current version the module does not support multi-database installation.</p> <p>The module only dependency is <cite>mail_tracking</cite>.</p> <p>No external python library are required.</p> <a name="configuration"></a> <h3>Configuration</h3> <p>Your Mandrill account must be configured in order to receive mail events via webhooks.</p> <ol class="arabic simple"> <li>Launch Odoo with the newly installed module</li> <li>Open the Mandrill web interface and select <cite>new webhook</cite> under the <cite>setting</cite> tab</li> <li>Select the list of events you want to be notified about and set the url as follows</li> </ol> <pre> <code lang="html">https://&lt;your_domain&gt;/mail/tracking/mandrill/&lt;your_database&gt;</code> </pre> <p>If Mandrill displays an error it might be because it wasn't able to reach your url. Make sure that your server is running and that the path to your route has been setup correctly.</p> <p>Once the webhook has been successfully created on the Mandrill interface it will receive a <cite>webhook key</cite>. This key is used to validate Mandrill request to your server and avoid undesired request from third party. More info on <a class="reference external" href="https://mailchimp.com/developer/transactional/guides/track-respond-activity-webhooks/#authenticating-webhook-requests">Mandrill's documentation</a>.</p> <p>To enable the validation process copy the key you've found on Mandrill's interface in your Odoo configuration file with the name <cite>mandrill_webhook_key</cite>.</p> <pre> <code lang="bash">mandrill_webhook_key = &lt;YOUR KEY&gt;</code> </pre> <p>If you choose <strong>not</strong> to specify the webhook key in your configuration file the route will still be accessible by Mandrill. <strong>But use caution as anyone with your url could trigger your route.</strong></p> <a name="usage"></a> <h3>Usage</h3> <p>Once configured changes are invisible for the backend user. No views have been added or modified. This module relies only on already existing ( trough <cite>mail_tracking</cite>) model <cite>mail_tracking_email</cite>. The appropriated process function will be triggered when an event from Mandrill is received.</p> <a name="known-issues-roadmap"></a> <h3>Known issues / Roadmap</h3> <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>Mandrill logo: <a class="reference external" href="https://seeklogo.com/vector-logo/273632/mandrill">SVG Icon</a>.</li> </ul> <a name="contributors"></a> <h4>Contributors</h4> <ul class="simple"> <li>Jonathan Guerne &lt;<a class="reference external" href="mailto:guernej&#64;compassion.ch">guernej&#64;compassion.ch</a>&gt;</li> </ul> <p>This work was mainly based on multiple other SMTP service integration in Odoo</p> <ul class="simple"> <li><a class="reference external" href="https://apps.odoo.com/apps/modules/8.0/mail_mandrill/">Mandrill mail events integration by Antiun IngenierĂ­a S.L., Odoo Community Association (OCA)</a></li> <li><a class="reference external" href="https://apps.odoo.com/apps/modules/12.0/mail_tracking_mailgun/">Mail tracking for Mailgun by Tecnativa , Odoo Community Association (OCA)</a></li> <li><a class="reference external" href="https://apps.odoo.com/apps/modules/10.0/mail_sendgrid/">SendGrid by Compassion CH , Odoo Community Association (OCA)</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="http://odoo-community.org">http://odoo-community.org</a>.</p>