rickyngk / loopback-connector-sendgrid

Loopback connector to send emails via SendGrid

Installation

npm install loopback-connector-sendgrid --save

Configuration

Sendgrid username and password

Use the following configuration if you have a username and password.

datasources.json

{
    "sendgrid": {
        "connector": "loopback-connector-sendgrid",
        "api_user": '[your username here]'
        "api_key": '[your password 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_user: '[your username here]'
    api_key: '[your password here]'
});
loopback.Email.attachTo(dsSendGrid);

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);

Usage

Basic option same as built in Loopback

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

Send with template:

loopback.Email.send({
    to: "[email protected], [email protected]",
    from: "[email protected]",
    subject: "subject",
    sub: {
        ":name": ["User-1", "User-2"]
    },
    filters: {
        templates: {
            settings: {
                enable: 1,
                template_id: "template-id"
            }
        }
    }
},
function(err, result) {
    if(err) {
        console.log('Upppss something crash');
        return;
    }
    console.log(result);
});

License

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

Copyright (c) 2015 John Barry

Dependencies

[email protected] - "MIT License (MIT)", documented by npm-licenses.