loopback-connector-sendgrid

Loopback connector module which allow to send emails via SendGrid

Installation

npm install loopback-connector-sendgrid --save

Configuration

Sendgrid API key

Use the following configuration if you have an api key.

datasources.json

{
    "sendgrid": {
        "connector": "loopback-connector-sendgrid",
        "api_key": '[your api key here]'
    }
}

model-config.json

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

Configuration in JavaScript

var DataSource = require('loopback-datasource-juggler').DataSource;
var dsSendGrid = new DataSource('loopback-connector-sendgrid', {
    api_key: '[your api key here]'
});
loopback.Email.attachTo(dsSendGrid);

Sendgrid settings

Using sendgrid mail_settings and tracking_settings: datasources.json

{
    "sendgrid": {
        "connector": "loopback-connector-sendgrid",
        "api_key": '[your api key here]',
        "mail_settings": {[your mail_settings JSON object]},
        "tracking_settings": {[your tracking_settings JSON object]}
    }
}

Usage

Basic option same as built in Loopback:

loopback.Email.send({
    to: "test@to.com",
    from: "test@from.com",
    subject: "subject",
    text: "text message",
    html: "html <b>message</b>"
},
function(err, result) {
    if(err) {
        console.log('Upppss something crash');
        return;
    }
    console.log(result);
});

Advanced options using the sendGridConfig option:

loopback.Email.send({
    to: "test@to.com",
    from: "test@from.com",
    subject: "subject",
    text: "text message",
    html: "html <b>message</b>",
    sendGridConfig: {
        personalizations: ...,
        template_id: ...,
        sections: ...,
        headers: ...,
        categories: ...,
        custom_args: ...,
        send_at: ...,
        batch_id: ...,
        asm: ...,
        ip_pool_name: ...,
        reply_to: ...
    }
},
function(err, result) {
    if(err) {
        console.log('Upppss something crash');
        return;
    }
    console.log(result);
});

API

documented by jsdoc-to-markdown.

Changelog

	Type	ID	Summary
Version: 2.0.3 - released 2016-07-09
	Bug	MDLPCNSG-31	Package: Add test steps for 2.0.2 and fix readme
Version: 2.0.1 - released 2016-07-08
	Bug	MDLPCNSG-30	Package: Fix library to use sendgrid web APIv3 configuration
Version: 2.0.0 - released 2016-07-08
	Non-functional	MDLPCNSG-29	Package: Move babel-core from dependencies to devDependencies
	Non-functional	MDLPCNSG-28	Package: Upgrade Sendgrid dependency from ^2.0.0 to ^3.0.4 (upgraded in version 1.2.4)
Version: 1.2.4 - released 2016-07-07
	Non-functional	MDLPCNSG-24	Package: update usage documentation to describe configuration of sendgrid api key
	Bug	MDLPCNSG-27	Email connector: Fix filters reference to higher scoped var sendgridFilters
	Non-functional	MDLPCNSG-26	Package: Update package dependencies
	Non-functional	MDLPCNSG-25	Package: Update package dependencies
Version: 1.2.3 - released 2016-02-16
	Non-functional	MDLPCNSG-23	Package: Update package dependencies
Version: 1.2.2 - released 2015-11-26
	Non-functional	MDLPCNSG-22	Package: Update package dependencies
Version: 1.2.0 - released 2015-10-05
	Feature	MDLPCNSG-16	Email connector: Add support for api_key
Version: 1.1.4 - released 2015-08-25
	Non-functional	MDLPCNSG-15	Package: Update development dependencies and configure for travis-ci
Version: 1.1.3 - released 2015-07-21
	Non-functional	MDLPCNSG-14	Package: Update package dependencies
Version: 1.1.2 - released 2015-07-14
	Non-functional	MDLPCNSG-13	Package: Update package dependencies
Version: 1.1.1 - released 2015-07-01
	Non-functional	MDLPCNSG-12	Package: Update package dependencies
Version: 1.1.0 - released 2015-06-30
	Bug	MDLPCNSG-11	Email connector: From address specification mismatch
	Feature	MDLPCNSG-10	Email connector: Send message attachments
Version: 1.0.3 - released 2015-04-20
	Non-functional	MDLPCNSG-9	Package: Update package dependencies
Version: 1.0.2 - released 2015-02-23
	Non-functional	MDLPCNSG-8	Package: Update package dependencies
	Non-functional	MDLPCNSG-7	Package: Update eslint configuration, test.js runner and dev dependencies
Version: 1.0.1 - released 2015-02-03
	Bug	MDLPCNSG-6	Email connector: Email subject line not set
Version: 1.0.0 - released 2015-02-03
	Feature	MDLPCNSG-5	Email connector: Add sendgrid filters passthrough from datasource
	Feature	MDLPCNSG-4	Email connector: Add sendgrid options passthrough from datasource
Version: 0.1.1 - released 2015-02-03
	Non-functional	MDLPCNSG-3	Package: Update package dependencies
Version: 0.1.0 - released 2015-02-02
	Feature	MDLPCNSG-2	Email connector: Add a loopback connector for sending emails from SendGrid

License

MIT License (MIT). All rights not explicitly granted in the license are reserved.

Copyright (c) 2015 John Barry

Dependencies

loopback-connector-sendgrid@2.0.2 - "MIT License (MIT)", documented by npm-licenses.