venn-messaging

Venn Email

Build in a redundant messaging service seamlessly. If your email, sms or push notification provider goes down, we'll fall back to a secondary service.

Use

Install

npm install venn-messaging

Functions

initialize(api_key, callback)

params	type	description	example
api_key	String	Venn API Key	64d2fa24h3f6f7cc61asp3e8

Email Send

send(data, callback)

params	type	description	example
data.from	String	from email address	[e-mail]
data.to	String	to email address	[e-mail]
data.subject	String	email subject	Subject 123
data.message	String	email message	How you doin?

SMS Send

send(data, callback)

params	type	description	example
data.from	String	from phone number	[phone]
data.to	String	to phone number	[phone]
data.message	String	text message	How you doin?

Email Example

vennEmail = require("venn-messaging").Email;

// initialize and send an email
vennEmail.initialize(VENN_API_KEY)
var data = {
	from: "[e-mail]",
	to: "[e-mail]",
	subject: "Subject 123",
	message: "How you doin"
}
vennEmail.send(data, function(err, result){
	// email successfully sent if !err
})

SMS Example

vennSms = require("venn-messaging").SMS;

// initialize and send an SMS
vennSms.initialize(VENN_API_KEY)
var data = {
	from: "[phone]",
	to: "[phone]",
	message: "How you doin"
}
vennSms.send(data, function(err, result){
	// email successfully sent if !err
})

#Development

adding a new email provider

• write failing tests
• add service to lib/models/providers (copy an existing provider)
  • change initialize and send functions to service specific way of initializing client/sending message
• edit email_client.js and require lib/models/providers/[newservice].js
  • then add it in the configureServices
• add api key validator to Venn API

install dependencies

npm install

Run Example

node examples/example.js

Run Example (with debug logging)

export VENN_API_KEY=""
DEBUG=email node examples/example.js

Run Tests

Export api keys

mocha