Skip to content

AlexaSRM/alexa-dev-mailer

Repository files navigation

Alexa Logo

Alexa Mailer


A CLI based mailer, leveraging the power of Amazon SES.

Created by Alexa Developers SRM.

version 1.0.0 license MIT author Alexa Dev SRM

Preview

Screenshot

Installation 🔧

Install dependencies and build the server

$ yarn && yarn build

Start the server

$ yarn start

License

Alexa Mailer is available under the MIT license. See the LICENSE file for more info.

Contributing

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Shout outs

The product is build by the following member(s):

Aniruddha Chatterjee
Aniruddha Chatterjee

Product Description

Collection

The CLI uses a default collection named alexa-mail. If you wish to change it, set the appropiate name as the evironment variable.

Document

Each document must confirm to the following structure

{
  "name":"list-name",
  "users":[
    {
      "email": "[email protected]
      // Any other properties can follow
    },
    {
      "email": "[email protected]
      // Any other properties can follow
      // So on...
    }
  ]
}

You can add any number of properties that you want to use in your dynamic email content.

Dynamic Email

This product uses dot.js to template the email content. You can use string interpolation as

{{=it.property1}}
{{=it.property2}}
// So on...

You can use such properties anywhere in the email content, for both HTML and text files. These properties come from the object array defined in the document in use.

Check example.html and example.txt to learn more.

About

A simple CLI based mailer by Alexa Developers SRM

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published