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

hapi-sendgrid

v0.0.1

Published

SendGrid client plugin for Hapi.js

Downloads

7

Readme

Build Status

hapi-sendgrid

Hapi.js plugin that exposes the SendGrid-nodejs library for sending emails through SendGrid.

Installation

npm install hapi-sendgrid --save

Usage

First, the SendGrid-nodejs requires authentication via either username/password OR an API key. When registering your plugin with Hapi, you must specify only one of the two. The accepted parameters are:

  • username and password
  • apiKey

Here's a simple example:

server.register({
    register: require('hapi-sendgrid'),
    options: {
        apiKey: 'myApiKey'
    }
 }, function (err) {

     if (err) {
         console.log('Failed loading plugin');
     }
 });

Once registered, you can access the plugin like so:

var sendGridClient = server.plugins['hapi-sendgrid'].client;

Once you have the client, you may access all of the existing functionality of the SendGrid-nodejs library.

Setting Default Send options

In addition to exposing the SendGrid-nodejs client, the plugin also introduces the ability to set default options that can be used to avoid having to set email options, such as from:, over and over again. Passing in an emailOptions object to the plugin, will merge those options with any specific options you may set when sending an email. For example:

server.register({
    register: require('hapi-sendgrid'),
    options: {
        apiKey: 'myApiKey',
        emailOptions: {
          from: '[email protected]'
        }
    }
 }, function (err) {
   if (err) { console.log('Failed loading plugin'); }

   var client = server.plugins['hapi-sendgrid'].client;

   // 'to:' is specified by default options
   var email = new client.sendGridClient.Email({
     to: '[email protected]',
     subject: 'whatup playa',
     text: 'word'
   });

   client.send(email).then(function(result) {
     console.log('SENT!');
     return done();
   }).catch(function(err) {
     console.error(err);
   });
});

In this example, setting the from property isn't necessary because the from property is inherited from the default emailOptions.

Setting Client options

You may also change how the SendGrid-nodejs library behaves, such as changing the endpoint, by passing any of the following options into plugin using the clientOptions object. For example:

server.register({
    register: require('hapi-sendgrid'),
    options: {
        apiKey: 'myApiKey',
        clientOptions: {
          protocol: "http",
          host: "sendgrid.org",
          endpoint: "/send",
          port: "80"
        }
    }
 }, function (err) {

     if (err) {
         console.log('Failed loading plugin');
     }
 });