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

postmark-email

v0.0.2

Published

light wrapper around Postmark API

Downloads

5

Readme

postmark-email

Server-side wrapper around Postmark API to send and handle an email response.

usage

npm install postmark-email //or bun install 

Get an API key from Postmark and create a .env file with the following values:

SEND_EMAIL=true
POSTMARK_API_KEY=xxxxx-xxx-xxxx-xxxxx-xxxxx
[email protected]

Then in your server JS do:

require('dotenv').config() //< not needed in Bun 

//Make sure your dot env is loaded BEFORE requiring:
const { sendEmail, handleEmailRes } = require('postmark-email')            

const send = () => //hypothetical fn to send the delivery status back
//ie- to your client-side UI 


const result = await sendEmail({
  to: '[email protected]', 
  subject : 'Welcome', 
  TextBody: `Hello there,

  how do you do? 

  Goodbye.`
}) 

if( handleEmailRes(result) ) {
  send({ ok: true }) 
} else {
  send({ msg : 'There was a problem sending the email' })
}               

sendEmail will send your email object using a from field based on your .env setting or otherwise you can override it using a from property in said email object.

handleEmailRes will also console out the status of if the email was sent or not plus any error so that you don't have to console out those yourself.

If handleEmailRes(resultFromSendEmail) is falsey there was an error so you can easilybubble that up to your client if need be.

If you supply the original email obj to handleEmailRes ex: handleEmailRes(resultFromSendEmail, originalEmailObj) the final output msg will include the originalEmailObj.to property.