Home

Awesome

io-app-email-templates

This repo contains the mail template(s) sent on behalf of IO App and its services. Templates are created using MJML markup language along with typescript files.

How to apply changes

To edit them, you can choose among these following options:

To generate the HTML output you need to install the following CLI tool:

  1. MJML package:
$ npm install -g mjml && mjml <MJML_INPUT_FILE> -o <OUTPUT_FILE>

Add a new template

Steps:

  1. Create a directory on the root of the project with a name of your choice.
  2. Put an apply method in a typescript file named applier.template.ts inside your template directory.
  3. Put a generation step inside package.json(follow the other scripts as example). This will generate an index.ts file with the template inside. Make sure to put {{TEMPLATE}} in the method that is going to be replaced with the HTML generated from the mjml file.
  4. Generate a snapshot test to make sure the content doesn't change unexpectedly

Compatibility

Templates are compatible with the following clients:

Related mail templates