awsm-mailer

✉️ awsm-mailer

AWSM package for sending emails.

Features

• 30 Pre-configured services (Gmail, Hotmail, SendGrid...etc)
• HTML content as well as plain text alternative
• 32 HTML template engines (handlebars, jade, haml...etc)
• Easy HTML styling with Juice
• Embedded images in HTML
• Email Attachments
• Unicode to use any characters In your JAWS project root directory, run:

Quick Usage

In your JAWS project root directory, run:

jaws module install https://github.com/jaws-framework/jaws-core-js
jaws module install https://github.com/eahefnawy/awsm-mailer

Set the following env vars (using CLI or the .env file):

EMAIL_SERVICE=Gmail
EMAIL_SERVICE_USER=[e-mail]
EMAIL_SERVICE_PASS=password

deploy your code with JAWS dash, then test the Lambda with the following event:

{
  "from": "[e-mail]",
  "to": "[e-mail]",
  "subject": "Hello",
  "template": "welcome",
  "context": {
    "first_name": "Sam",
    "last_name": "Smith"
  }
}

This will use the welcome template coupled with the context/data (first_name & last_name). You should receive an email that says:

Welcome Sam Smith

You can edit the template text by editing these two files:

<project-dir>/back/aws_modules/awsm-mailer/send/templates/html.handlebars
<project-dir>/back/aws_modules/awsm-mailer/send/templates/text.handlebars

Supported Services

awsm-mailer supports the following 30 service, pre-configured and ready to use. You just provide the username/password:

• '1und1'
• 'AOL'
• 'DebugMail.io'
• 'DynectEmail'
• 'FastMail'
• 'GandiMail'
• 'Gmail'
• 'Godaddy'
• 'GodaddyAsia'
• 'GodaddyEurope'
• 'hot.ee'
• 'Hotmail'
• 'iCloud'
• 'mail.ee'
• 'Mail.ru'
• 'Mailgun'
• 'Mailjet'
• 'Mandrill'
• 'Naver'
• 'Postmark'
• 'QQ'
• 'QQex'
• 'SendCloud'
• 'SendGrid'
• 'SES'
• 'Sparkpost'
• 'Yahoo'
• 'Yandex'
• 'Zoho'

Template Engines

awsm-mailer comes with a welcome template for demonstration. You can add/remove templates from the following directory:

<project-dir>/back/aws_modules/awsm-mailer/send/templates/

awsm-mailer uses handlebars as the default template engine. You can use any other template engine by adding it to the package.json file and update dependencies with npm install.

Here's the full list of supported templates:

• atpl
• doT.js (website)
• dust (unmaintained) (website)
• dustjs-linkedin (maintained fork of dust) (website)
• eco
• ect (website)
• ejs
• haml (website)
• haml-coffee (website)
• hamlet
• handlebars (website)
• hogan (website)
• htmling
• jade (website)
• jazz
• jqtpl (website)
• JUST
• liquor
• lodash (website)
• mote (website)
• mustache
• nunjucks (website)
• QEJS
• ractive
• react
• swig (website)
• templayed
• liquid (website)
• toffee
• underscore (website)
• walrus (website)
• whiskers

after chosing your template engine, make sure the file extentions of the template files match the template you chose:

html.{{ext}}
text.{{ext}}
style.{{ext}}

Mail Options (Event Properties):

Here's the full list of options you can pass in your event:

• from - The e-mail address of the sender. All e-mail addresses can be plain '[e-mail]' or formatted 'Sender Name <[e-mail]>', see here for details
• sender - An e-mail address that will appear on the Sender: field
• to - Comma separated list or an array of recipients e-mail addresses that will appear on the To: field
• cc - Comma separated list or an array of recipients e-mail addresses that will appear on the Cc: field
• bcc - Comma separated list or an array of recipients e-mail addresses that will appear on the Bcc: field
• replyTo - An e-mail address that will appear on the Reply-To: field
• inReplyTo - The message-id this message is replying
• references - Message-id list (an array or space separated string)
• subject - The subject of the e-mail
• template - The template to use for this email. Make sure it matches one of the folder names inside the templates folder
• context - The context/data the template needs. eg. {"first_name": "..."}
• watchHtml - Apple Watch specific HTML version of the message (experimental)
• headers - An object or array of additional header fields (e.g. {"X-Key-Name": "key value"} or [{key: "X-Key-Name", value: "val1"}, {key: "X-Key-Name", value: "val2"}])
• attachments - An array of attachment objects
• alternatives - An array of alternative text contents (in addition to text and html parts)
• envelope - optional SMTP envelope, if auto generated envelope is not suitable
• messageId - optional Message-Id value, random value will be generated if not set
• date - optional Date value, current UTC string will be used if not set
• encoding - optional transfer encoding for the textual parts