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.
To edit them, you can choose among these following options:
To generate the HTML output you need to install the following CLI tool:
- MJML package:
$ npm install -g mjml && mjml <MJML_INPUT_FILE> -o <OUTPUT_FILE>Steps:
- Create a directory on the root of the project with a name of your choice.
- Put an
applymethod in a typescript file namedapplier.template.tsinside your template directory. - Put a generation step inside
package.json(follow the other scripts as example). This will generate anindex.tsfile 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. - Generate a snapshot test to make sure the content doesn't change unexpectedly
Templates are compatible with the following clients:
- Apple Mail 13+ (dark mode included)
- Gmail Web app
- OL Office 365 (dark mode included, partially supported on Windows)
- Outlook 2013, 2016, 2019, 2021 (dark mode included, partially supported on Windows)
- Windows 10 Mail (dark mode partially supported)
- Windows 11 Mail
- Gmail App (Android 6+, dark mode partially supported)
- Gmail App (iOS 13.1+, dark mode partially supported)
- iPad (iOS 13.1+)
- iPhone (iOS 13.1+)
- AOL Mail
- Outlook.com Mail (dark mode partially supported)
- Yahoo! Mail