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

yamailer

v1.0.3

Published

Simple `nodemailer` wrapper. See `./test` folder for examples.

Downloads

4

Readme

yamailer - Yet Another Mailer

Simple nodemailer wrapper. See ./test folder for examples.

Accepted options are the same ones accepted by nodemailer.

Install

npm install yamailer

Import

const yamailer = require('yamailer')
    , yam = new yamailer(/* { Optional options object in the nodemailer way } */)

Methods

  • addAttachment: Add attachment as object. Valid properties are:
    yam.addAttachment({
        filename, //  'text1.txt',
        content, // 'hello world!' // new Buffer('hello world!','utf-8') // fs.createReadStream('file.txt') // 'aGVsbG8gd29ybGQh'
        path, // '/path/to/file.txt' // 'https://raw.github.com/nodemailer/nodemailer/master/LICENSE' // 'data:text/plain;base64,aGVsbG8gd29ybGQ='
        contentType, // 'text/plain'
        encoding, // 'utf-8', 'base64'
        raw// 'Content-Type: text/plain\r\n' + 'Content-Disposition: attachment;\r\n' + '\r\n' + 'Hello world!'
    })
  • addAttachments: Add array of attachments (see method above)
    yam.addAttachments([ ... ])
  • addRecipient: Add email recipient (this must be a valid email address)
    yam.addRecipient('[email protected]')
  • addRecipients: Add array of email recipients (array of valid email addresses)
    yam.addRecipients(['[email protected]', '[email protected]'])
  • from: specify sender email and name
    yam.from('[email protected]', 'Mail sender name')
  • html: specify email HTML contents
    yam.html('<h1>Hello World!</h1>')
  • options: specify options
    yam.options({
        // options object in the nodemailer way
    });
  • send: send email (it returns a <Promise>)
    yam.send()
  • subject: specify email subject
    yam.subject('What\'s up?!')
  • text: specify email plain text contents
    yam.subject('Greetings from Malibù!')

Other references

For additional info about nodemailer input options: https://www.npmjs.com/package/nodemailer

Full example

npm install yamailer hotenv

const yamailer = require('yamailer')
    , hotenv = require('hotenv');
hotenv(__dirname+'/.env');

const yam = new yamailer()
    , username = process.env.GMAIL_USERNAME
    , password = process.env.GMAIL_PASSWORD
    , recipient = process.env.EMAIL_RECIPIENT;

yam.options({
    service: 'gmail',
    host: 'smtp.gmail.com',
    auth: {
            user: username,
            pass: password
    }
})
.from(username)
.addRecipient(recipient)
.subject('test')
.text('test')
.send()
.then(console.log)
.catch(console.log);