Author: |
Compassion CH |
License: |
no license |
Branch: |
r4 |
Repository: |
MickSandoz/compassion-switzerland |
Dependencies: |
connector,
mail,
mail_sendgrid,
and
sbc_compassion |
Languages: |
PO File (430, 35.3%),
Python (572, 46.9%),
XML (189, 15.5%),
and
reStructuredText (28, 2.3%) |
Other branches: |
master |
Other repositories: |
HeerPhilippe/compassion-switzerland,
emgirardin/compassion-switzerland,
and
maxime-beck/compassion-switzerland |
<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a name="sponsor-to-beneficiary-email-communication"></a>
<h2>Sponsor to beneficiary email communication</h2>
<p>This module allows to send child letters to sponsors through email.
It adds option to import letters with import configuration and option to select
multiple letters on import.</p>
<a name="configuration"></a>
<h2>Configuration</h2>
<p>You must add the following system parameters:</p>
<ul class="simple">
<li><code>sbc_email.from_address</code> email address which sends the letters to sponsors.</li>
</ul>
<a name="usage"></a>
<h2>Usage</h2>
<p>Used by the onramp_compassion module to send an email on reception of a new
child letter.</p>
<p>The letter is sent to the sponsor's email address, using a SendGrid email
template corresponding to the sponsor's language. Templates for every language
have to be registered in the TemplateList model after creating them on the
<a class="reference external" href="https://sendgrid.com/templates">SendGrid web interface</a>.</p>
<p>The template should contain the following substitution variables which will be
replaced with corresponding values:</p>
<ul class="simple">
<li><code>{sponsor}</code> Full name of the sponsor</li>
<li><code>{child}</code> First name of the child</li>
<li><code>{letter_url}</code> URL where the letter can be viewed/downloaded</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>