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

sendgrid-mail

v0.0.3

Published

The easiest way to send mail with sendgrid.

Downloads

1,046

Readme

Mail for Sendgrid

Main repo: https://github.com/huned/nodejs-sendgrid-mail

This is the simplest way to send mail with sendgrid in node.js.

Features:

  • Use as a library or as a command line utility
  • Command line utility has a mail style interface and sensible defaults
  • Supports sending plain text and html emails
  • No bloat, few dependencies

Installation

npm install sendgrid-mail

Usage

sgSendmail = require('sendgrid-mail')

sgSendmail({
  // Required SendGrid API key
  apikey: 'your sendgrid api key',

  // Optional to/cc/bcc fields.
  // Specify at least one email address in any of these fields.
  to: ['John Doe <[email protected]>'],
  cc: [],
  bcc: [],

  // Optional from/replyTo fields.
  // The from address must be a verified sender in your SendGrid account.
  from: 'Jane Doe <[email protected]>',
  replyTo: '[email protected]',

  // Optional subject of the email
  subject: 'test subject',

  // Optional body of the email
  body: 'plain text body',

  // Optional content type of email body.
  contentType: 'text/html',

  // Optionally avoid sending empty emails
  suppressEmpty: true,
})

Command Line Usage

$ echo 'hello, world.' | sendgrid-mail -k <sendgrid api key> -s 'Test Subject' [email protected] [email protected]

You can specify options (see sendgrid-mail --help for more details)

-E
--suppressEmpty
    OPTIONAL
    Do not send messages with an empty body.

-s <subject>
--subject=<subject>
    OPTIONAL
    Specify subject on command line. (Only the first argument after the
    -s flag is used as a subject; be careful to quote subjects containing
    spaces.)

-c <cc-addr>
--cc=<cc-addr>
    OPTIONAL
    Send carbon copies to cc-addr list of users. The cc-addr argument
    should be a comma-separated list of email addresses.

-b <bcc-addr>
--bcc=<bcc-addr>
    OPTIONAL
    Send blind carbon copies to bcc-addr list of users. The bcc-addr
    argument should be a comma-separated list of email addresses.

The following options are specific to this program and used when calling
SendGrid's API v3 /mail/send endpoint.

-k <api key>
--key=<api key>
    REQUIRED
    Set a SendGrid API key. Can also be set by defining SENDGRID_API_KEY.

--from=<from-addr>
    REQUIRED
    Set the from-addr for outgoing messages. Can also be set by defining
    SENDGRID_MAIL_FROM.

    **IMPORTANT** from-addr must be a verified sender for your SendGrid
    account.

--replyTo=<replyto-addr>
    OPTIONAL
    Set the reply-to field for outgoing messages. Can also be set by
    defining SENDGRID_MAIL_REPLYTO. If unset, defaults to $REPLYTO.

--html
    OPTIONAL
    Indicate that mail body content type is "text/html". If unset, mail
    content type is "text/plain".

Author(s)

License

MIT

TODOs

  • [ ] tests
  • [ ] multipart email