Search 1.9 billion lines of Odoo code on GitHub
mail_sendgrid
<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a name="sendgrid-mail-sending-and-tracking"></a>
<h2>SendGrid Mail Sending and Tracking</h2>
<p>This module integrates
<a class="reference external" href="https://sendgrid.com/">SendGrid</a> with Odoo. It can send transactional emails
through SendGrid, using templates defined on the
<a class="reference external" href="https://sendgrid.com/templates">SendGrid web interface</a>. It also supports
substitution of placeholder variables in these templates. The list of available
templates can be fetched automatically.
E-mails sent through SendGrid will be tracked using Sendgrid Webhook Events.</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>You need to install python-sendgrid v3 API in order to install the module.</p>
<p>If you're using a multi-database installation (with or without dbfilter option)
where /web/databse/selector returns a list of more than one database, then
you need to add <code>mail_sendgrid</code> addon to wide load addons list
(by default, only <code>web</code> addon), setting <code>--load</code> option.
For example, <code>--load=web,mail_tracking,mail_sendgrid</code></p>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>You can add the following system parameters to configure the usage of SendGrid:</p>
<ul class="simple">
<li><code>mail_sendgrid.substitution_prefix</code> Any symbol or character used as a
prefix for <a class="reference external" href="https://sendgrid.com/docs/API_Reference/SMTP_API/substitution_tags.html">SendGrid Substitution Tags</a>.
<code>{</code> is used by default.</li>
<li><code>mail_sendgrid.substitution_suffix</code> Any symbol or character used as a
suffix for SendGrid Substitution Tags.
<code>}</code> is used by default.</li>
<li><code>mail_sendgrid.send_method</code> Use value 'sendgrid' to override the traditional SMTP server used to send e-mails with sendgrid.
By default, SendGrid will co-exist with traditional system
(two buttons for sending either normally or with SendGrid).</li>
</ul>
<p>In order to use this module, the following variables have to be defined in the
server command-line options (or in a configuration file):</p>
<ul class="simple">
<li><code>sendgrid_api_key</code> A valid API key obtained from the
SendGrid web interface <<a class="reference external" href="https://app.sendgrid.com/settings/api_keys">https://app.sendgrid.com/settings/api_keys</a>> with
full access for the <code>Mail Send</code> permission and read access for the
<code>Template Engine</code> permission.</li>
</ul>
<p>Optionally, the following configuration variables can be set as well:</p>
<ul class="simple">
<li><code>sendgrid_test_address</code> Destination email address for testing purposes.
You can use <code>odoo@sink.sendgrid.net</code>, which is an address that
will simply receive and discard all incoming email.</li>
</ul>
<p>For tracking events to work, make sure you configure your Sendgrid Account with the correct Event Notification Url.
You can do it under 'Settings -> Mail Settings -> Event Notification '.
Set the URL to <code>https://<your_domain>/mail/tracking/sendgrid/<your_database></code></p>
<p>Replace '<your_domain>' with your Odoo install domain name
and '<your_database>' with your database name.</p>
<a name="usage"></a>
<h3>Usage</h3>
<dl class="docutils">
<dt>If you designed templates in Sendgrid that you wan't to use with Odoo:</dt>
<dd><ul class="first last simple">
<li>Go to 'Settings -> Email -> SendGrid Templates'</li>
<li>Create a new Template</li>
<li>Click the "Update" button : this will automatically import all your templates</li>
</ul>
</dd>
</dl>
<p>In e-mail templates 'Settings -> Email -> Templates', you can attach a SendGrid template for any language.
You can substitute Sendgrid keywords with placeholders or static text like in the body of the e-mail.
The preview wizard now renders your e-mail with the SendGrid template applied.</p>
<p>From e-mails, use the "Send (SendGrid)" button to send the e-mail using Sendgrid.</p>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/205/10.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>Extend the features from SendGrid</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>Sengrid logo: <a class="reference external" href="http://seeklogo.com/vector-logo/289294/sendgrid">SVG Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Emanuel Cino <<a class="reference external" href="mailto:ecino@compassion.ch">ecino@compassion.ch</a>></li>
<li>Roman Zoller <<a class="reference external" href="mailto:rzcomp@gmail.com">rzcomp@gmail.com</a>></li>
<li>Isaac Gallart <<a class="reference external" href="mailto:igallart@puntsistemes.es">igallart@puntsistemes.es</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>