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

@monkey_king/sendemail

v1.0.3

Published

A node package to send emails built ontop of nodemailer

Downloads

2

Readme

@monkey_king/sendemail

A node package to send emails built on top of nodemailer. This package uses mailgun as transporter for now...

Installation

To get started, run:

npm i @monkey_king/sendemail

Usage

To use this package, you will need an account at https://www.mailgun.com/.

To use this, in an ECMAScript, you will need to:

import { sendEmail } from "@monkey_king/sendemail";

const send = () => {
  sendEmail(
    auth, //required. will be the authentication object required by mailgun
    //auth = {auth: {api_key: <Your private key>, domain: <Your domain>}}

    sender, //required. string of the email sending the mail.
    //It should be the same as the one used to create mailgun account

    recipient, //required. Array of the list of emails to send to. They should
    // be verified emails if you are using a free foundation plan in mailgun

    subject, //required. string of the email subject

    emailContent, //required. html passed as a string (ex: '<h1>Hello everyone</h1>')

    callback //optional, takes two params. (error, result) => ...
  );
};

Example:

import {sendEmail} from '@monkey_king/sendemail'

const auth = {
    auth: {
        api_key: <Your API key>,
        domain: <Your domain>
    }
}

const emailContent = `
    <div>
        <h1>Hello</h1>
        <p>Welcome to the party</p>
    </div>
`

const send = () => {
    sendEmail(
        auth,
        [email protected],
        ["[email protected]", "[email protected]"],
        "Test the package",
        emailContent
    )
}

To use this, in an CommonJS, you will need to:

const { sendEmail } = require("@monkey_king/sendemail");

/**
 * Rest of code goes here as for ECMAScript
 */

What next?

We will be building to add aws SES and other transporters

Contributing

Your pull request is one button away, don't hesitate. Face any issue? let us know

License

This has an MIT license.