Author: |
Compassion CH |
License: |
no license |
Branch: |
8.0 |
Repository: |
MickSandoz/compassion-modules |
Dependencies: |
base,
and
mail |
Languages: |
PO File (65, 21.5%),
Python (162, 53.5%),
and
XML (76, 25.1%) |
<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a name="sendgrid"></a>
<h2>SendGrid</h2>
<p>This module integrates the basic functionality of
<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.</p>
<a name="usage"></a>
<h2>Usage</h2>
<p>In order to use this module, the following variables have to be defined in the
server configuration file:</p>
<ul class="simple">
<li><code>sendgrid_api_key</code> A valid API key obtained from the
<a class="reference external" href="https://app.sendgrid.com/settings/api_keys">SendGrid web interface</a> with
full access for the <code>Mail Send</code> permission and read access for the
<code>Template Engine</code> permission.</li>
<li><code>sendgrid_from_address</code> The sender address that will be shown for emails
sent through SendGrid.</li>
</ul>
<p>Optionally, the following configuration variables can be set as well:</p>
<ul class="simple">
<li><code>sendgrid_production_mode</code> If set to <code>1</code> (or any other value), the module
will run in production mode and send emails to their true destination
address. Otherwise, all emails will be sent to <code>sendgrid_test_address</code>.</li>
<li><code>sendgrid_test_address</code> Destination email address for testing purposes. By
default, this is set to <code>odoo@sink.sendgrid.net</code>, which is an address that
will simply receive and discard all incoming email.</li>
</ul>
<a name="credits"></a>
<h2 class="with-subtitle">Credits</h2>
<h2 class="section-subtitle" id="maintainer"><span class="section-subtitle">Maintainer</span></h2>
<p>This module is maintained by
<a class="reference external" href="https://www.compassion.ch">Compassion Switzerland</a>.</p>