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

@bettercorp/postal

v0.0.1

Published

Node Typescript library for open source mail delivery platform, Postal

Downloads

14

Readme

Postal for Node

** documentation in progress for migration to TypeScript.
TS version works similar to the original nodeJS version below, just follow the types.
**

This library helps you send e-mails through the open source mail delivery platform, Postal in Node.

Installation

Install the library using NPM:

$ npm install @bettercorp/postal --save

Usage

Sending an email is very simple. Just follow the example below. Before you can begin, you'll need to login to your installation's web interface and generate new API credentials.

// Include the Postal library
import { SendMessage as PostalClient } from '@bettercorp/postal';

// Create a new Postal client using a server key generated using your
// installation's web interface
const client = new PostalClient('postal.yourdomain.com', 'your-api-key');

// Create a new message
let message = client.to('[email protected]');

// Add some recipients
message.to('[email protected]');
message.cc('[email protected]');
message.bcc('[email protected]');

// Specify who the message should be from - this must be from a verified domain
// on your mail server
message.from('[email protected]');

// Set the subject
message.subject('Hi there!');

// Set the content for the e-mail
message.plainBody('Hello world!');
message.htmlBody('<p>Hello world!</p>');

// Add any custom headers
//message.header('X-PHP-Test', 'value');

// Attach any files
message.attach('textmessage.txt', 'text/plain', 'Hello world!');

// Send the message and get the result
await message.send()