loopback-connector-mailgun
v0.0.13
Published
Loopback connector module which allow to send emails via Mailgun
Downloads
425
Readme
loopback-connector-mailgun
Loopback connector module which allow to send emails via Mailgun.
1. Installation
npm install loopback-connector-mailgun --save
2. Configuration
datasources.json
{
"mailgun": {
"connector": "loopback-connector-mailgun",
"apikey": "[your api key here]",
"domain": "[your domain here]"
}
}
model-config.json
{
"Email": {
"dataSource": "mailgun",
"public": false
}
}
Additionaly you can set defaults
{
"mailgun": {
"connector": "loopback-connector-mailgun",
"apikey": "[your api key here]",
"host": "[your mailgun region here]"
"defaults": {
"someSettings": "SomeSettingsValues"
}
}
}
3. Use
Basic option same as built in Loopback. Returns a Promise
loopback.Email.send({
to: "[email protected]",
from: "[email protected]",
subject: "subject",
text: "text message",
html: "html <b>message</b>",
attachments : [path.resolve('../client/images/an-image.jpg')],
var : {
myVar1 : 'a custom value'
},
headers : {
"X-My-Header" : "My Custom header"
}
})
.then(function(response){})
.catch(function(err){});
###Example of attaching a file stream In this case we will pass a file stream as an attachment. Note the structure of the attachment object, every property is required by mailgun in order to send the attachment. Omitting properties will cause mailgun to drop your attachment, the message will be delivered though
var path = require('path');
var mime = require('mime');
var file = path.resolve('../client/images/an-image.jpg');
var fileStream = fs.createReadStream(file);
var fileStat = fs.statSync(file);
var attachment = {
data: fileStream,
filename: path.basename(file),
knownLength: fileStat.size,
contentType: mime.lookup(file)//REQUIRED, by omitting this, mailgun will not send your attachment
};
loopback.Email.send({
to: "[email protected]",
from: "[email protected]",
subject: "subject",
text: "text message",
html: "html <b>message</b>",
attachments : [attachment]
})
.then(function(response){})
.catch(function(err){});
###quick note on attachments Refer to Mailgun documentation on limitations concerning attachments. The attachments property can be either an array of strings or buffers or a string.