Serverless Ses Template

homepage icon https://github.com/haftahave/serverless-ses-template
Follow @haftahave

Tracked

NPM Downloads Last Month
139
Issues
0
Stars
4
Forks
1
Watchers
4
Watch Star Fork Issue Download License NPM Build Status Coverage Status Contributors

Repo README Contents:

Build Status

Template sync plugin for Amazon Simple Email Service

A serverless plugin that allows automatically creating, updating and removing AWS SES Templates using a configuration file and keeps your AWS SES Templates synced with your configuration file.

REQUIRES nodejs 8.10+


:zap: Features

Installation

npm install @haftahave/serverless-ses-template

Configuration

# add to your serverless.yml

plugins:
  - '@haftahave/serverless-ses-template'

custom:
  sesTemplatesAddStageAlias: true                          # Specifies whether to add stage and alias to template name
  sesTemplatesConfigFile: './custom-config-file/path.js'   # Config file path (default './ses-email-templates/index.js')

Template configuration file

Template configuration file should be an array of objects:

module.exports = [{
    name: 'example_name',
    subject: 'Your subject',
    html: '<h1>Hello world!</h1>',
    text: 'Hello world!',
}];

Real world example see here:

Usage and command line options

Run sls ses-template deploy in order to sync your email templates.

Optional CLI options:

--remove-missed   Set this flag in order to remove templates those are not present in your configuration file. [OPTIONAL]
--stage           The stage used to populate your templates. Default: the first stage found in your project. [OPTIONAL]
--region          The region used to populate your templates. Default: the first region for the first stage found. [OPTIONAL]
--alias           Template alias, works only with sesTemplatesAddStageAlias option enabled. [OPTIONAL]

Run sls ses-template delete --template template_name_goes_here in order to delete your email template.

CLI options:

--template      The template name you are going to delete [REQUIRED]
--stage         The stage used to populate your templates. Default: the first stage found in your project. [OPTIONAL]
--region        The region used to populate your templates. Default: the first region for the first stage found. [OPTIONAL]
--alias         Template alias, works only with sesTemplatesAddStageAlias option enabled. [OPTIONAL]

License

MIT