GP Email

This class can be used to queue emails with SQS. It requires instantiating with an instance of SQS from the AWS-SDK, but this is not listed as a requirement for the module.

Installation

First you need to set up your local NPM to use Verdaccio if you haven't already

npm set registry http://npm.gpapi.uk:4873/

If you're using yarn

yarn config set registry http://npm.gpapi.uk:4873/

Then install the package

npm install gp-email --save

If you're using yarn

yarn add gp-email

Usage

You must first set up the AWS SDK. Then require the class and instantiate using the AWS instance you have created.

const AWS = require("aws-sdk")
const GPEmail = require("gp-email")
const gpEmail = new GPEmail(AWS)

You can then use this to send any of the specified emails. All parameters are required as follows:

OTP Code emails

await gpEmail.sendOtpEmail(otp, employee, client, type, email)

Welcome Letter emails

await gpEmail.sendWelcomeLetterEmail(client, employee, email)

Survey Notification emails

await gpEmail.sendSurveyNotificationEmail(client, employee, email)

Athena Document Share Notification emails

sendAthenaDocumentShareEmail(recipientName, docName, senderName, email)

Amazon Voucher Notification emails

sendAmazonVoucherEmail(client, employee, email, value, msg)

Kudos Notification emails

sendKudosNotificationEmail(client, employee, email, msg)

Send Creation Form Email

sendCreationFormEmail(email, clientName)