Email System

Date: 2020-06-06

Scope

Emails sent by JapanRabbit

Status

Accepted

Context

JapanRabbit needs to send emails to customers on specific events. We need a service to deliver these emails.

Decision

We will use Postmark as the email delivery service. All the email logic is stored in api/src/services/notifier, while the email templates are stored in Postmark dashboard.

Each email type gets different variables but the following ones are always sent for every template:

• homeBaseUrl: Url without ending slash
• appBaseUrl: Url without ending slash
• docsBaseUrl: Url without ending slash
• [locale]: Boolean. E.g. en: true for English.
• lang: String containing the locale. E.g. lang: 'en'.