Package Exports

@haftahave/serverless-ses-template

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@haftahave/serverless-ses-template) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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+

⚡ Features

Allows declaring email templates that will be synced in pre-deploy phase
Allows you to optionally add stage to template names while syncing
- Will also add alias, if specified (supports serverless-aws-alias plugin)
Allows you to list and delete SES template by specified name

Installation

npm install @haftahave/serverless-ses-template

Configuration

All @haftahave/serverless-ses-template configuration parameters are optional

# add to your serverless.yml

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

custom:
  sesTemplatesDisableAutoDeploy: true                    # Specifies whether to sync templates while sls deploy (default false)
  sesTemplatesAddStageAlias: true                        # Specifies whether to add stage and alias (if present) to template name (default false)
  sesTemplatesConfigFile: './custom-config-file/path.js' # Config file path (default './ses-email-templates/index.js')
  sesTemplatesRegion: 'us-west-2'                        # Specifies AWS region for SES templates (not required)

Template configuration file

Template configuration file should be an async function that returns array of objects (all keys are required):

/**
 * @param {Object} serverless - Serverless instance
 * @param {Object} options - runtime options
 * @returns {Promise<{name: string, subject: string, html: string, text}[]>}
 */
module.exports = async (serverless, options) => [{
    name: 'example_name',
    subject: 'Your subject',
    html: '<h1>Hello world!</h1>',
    text: 'Hello world!',
}];

Real world example see here.

Plugin resolves region in the following order:

CLI argument named sesTemplatesRegion - top priority
serverless.yml custom key named sesTemplatesRegion
CLI argument named region
fallback to default region resolving (first region in first stage defined in serverless.yml)

Plugin resolves template configuration file path in the following order:

CLI argument named sesTemplateConfig - top priority
serverless.yml custom key named sesTemplatesConfigFile
fallback to default ./ses-email-templates/index.js

Usage and command line options

Deploy

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

Optional CLI options: --sesTemplatesRegion The region used to populate your templates. Default: see "Region fallback sequence" in readme.md. [OPTIONAL] --sesTemplateConfig Template configuration file path. Default: see "Template configuration file sequence" in readme.md. [OPTIONAL] --stage The stage used to populate your templates. Default: the first stage found in your project. [OPTIONAL] --alias Template alias, works only with sesTemplatesAddStageAlias option enabled. [OPTIONAL] --removeMissed Set this flag in order to remove templates those are not present in your configuration file. [OPTIONAL]

List templates

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

CLI options:

--sesTemplatesRegion The region used to list your templates. Default: see "Region fallback sequence" in readme.md. [OPTIONAL]
--filter <string>    Display templates that contain <string>. [OPTIONAL]

Delete template

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