loopback-sendgrid-connector

Simple Loopback connector for SendGrid Mail service. Inspired by loopback-connector-sendgrid

Installation

npm install loopback-sendgrid-connector --save

Documentation

Configuration

SendGrid API key

Three steps to add connector to your app:

1. Get SendGrid API key,
2. Add configutation to datasource.json,
3. Add configuration to model-config.json

1. API key

You can get your SendGrid API key in your SendGrid Dashboard -> Settings -> API keys

2. datasource.json

{
  "sendgrid": {
    "connector": "loopback-sendgrid-connector",
    "api_key": "your_api_key",
    "from": "default_sender_email (not required)"
  }
}

or you can specify your env key, and connector will use this as api_key for Sendgrid

{
  "sendgrid": {
    "connector": "loopback-sendgrid-connector",
    "api_key_env": "your_env_var",
    "from": "default_sender_email (not required)"
  }
}

3. model-config.json

{
  "Email": {
    "dataSource": "sendgrid",
    "public": false
  }
}

Usage

You can use callback (promises in future).

Simple usage:

loopback.Email.send({
  to: "[email protected]",
  from: "[email protected]",
  subject: "Your subject",
  text: "Some text",
  html: "<b>Some message</b>"
},
function (err, result) {
  if(err) {
    console.log('[!] Error', err);
    return;
  }
  console.log(result);
});

Advanced usage:

loopback.Email.send({
  to: "[email protected]",
  from: "[email protected]",
  subject: "Your subject",
  text: "Some text",
  html: "<b>Some message</b>",
  templateId: "your_sendgrid_template_id",
  substitutions: {
    name: 'John',
    city: 'NY'
  }
// and mamy more, according to SendGrid Mail documentation (link below)
},
function (err, result) {
  if(err) {
    console.log('[!] Error', err);
    return;
  }
  console.log(result);
});

Also you can specify TO field as an array to send email to multiple recipients:

to: ["[email protected]", "[email protected]", "[email protected]"]

List of all options for SendGrid Mail API.

SendGrid send mail examples (most of them you can use in this connector)

In future

1. Add promises support
2. Write tests :)