npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pretty-emails

v1.0.2

Published

A simple node library to send html emails

Downloads

5

Readme

Pretty-email is just that, a package to help you write your html emails. No need to embed HTML tags inside strings.

Installation

npm install pretty-emails

Usage

Pretty-email supports three template engines nameley :-

  • Handlebars
  • Ejs
  • and Pug

I wanted to add more but wanted to keep it as lightweight as possible

Setting up config

    const pretty = require("pretty-emails");
     pretty.config({
      service:"Mailgun",
      auth:{
       user:"mysmptusername",
       pass:"mysmptpassword"

      },
      templateEngine:"handlebars" //or ejs/pug
      templateFile:"/views/myPrettyEmail" //no extension needed
    })

Configurations

  • service : well known smtp service that are supported by nodemailer
  • auth : credentials used to login to the service provider
  • templateEngine: Type of template engine to render, options include handlebars, ejs, pug
  • templateFile: Path to the template file. No need to add the extension.

NOTE : templateFile needs the first / to determine exactly where the file for instance templateFile:"/mysubfolder/templateName" or templateFile:/templateName will work but templateFile:subfolder/file will not

Since pretty-email uses nodemailer, most of the options available with nodemailer can be used with pretty-email as well such as

  • port
  • smtp

for a complete list of configurations you can check out nodemailer

MailOptions After you configure your mail transport settings simply put in the options of the reciepent and sender in the mailOptions settings

    pretty.mailOptions({
     to:"[email protected]",
     from:"Forest whitaker <[email protected]>"
     subject:"Welcome to Jurrasic Park",
     data:{
      variable1:"value",
      variable2:"value2"
     }

    }) 

The data property holds the optional variables you want to change in the html markup, this can be useful when sending multiple emails and would like to dynamically change some fields

An example in handlebars would be:

    <h2>How are you doing {{person}}</h2>
    Just wanted to invite you to our yearly {{name}} conference Don't miss it

The corresponding data object would be

    pretty.mailOptions({
    ...
     data:{
      person:"Spiderman",
      name:"Comicon"
     }
    ...
    })                                            

As with config most of the options that come with node-mailer can be used such as :-

  • attachments
  • header
  • messageId

for a complete list of options you can check out nodemailer

And finally

    pretty.send();

and that's pretty much it Feel free to contribute to this package and lets make emails pretty again!!