unisender

Promise-based wrapper for unisender api

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
unisender
541.1.14 years ago7 years agoMinified + gzip package size for unisender in KB

Readme

node-unisender
Promise-based wrapper for UniSender API. Sends POST request to UniSender.
Build Status Test Coverage Code Climate Dependency Status Version Downloads
List of available in module methods is in src/config/methods.js.

Installation

npm install unisender

Usage

You can send request to unisender API via calling function of unisender object with appropriate name:
unisender.<method name>(options);
for example
var UniSender = require('unisender');

var uniSender = new UniSender({
	api_key: 'YOUR_API_KEY',
	lang: 'ru'                // optional, 'en' by default
});

uniSender.getLists().then(console.log);

uniSender.createEmailMessage({
	sender_name: 'Test',
	sender_email: 'admin@example.com',
	subject: 'hello',
	body: '<h1>Hello world!</h1>',
	list_id: 1234567
}).then(function (response) {
	console.log('Message id: ' + response.result.message_id);
}).catch(function (response) {
	console.log('Error:' + response.error);
});

Full list of UniSender methods and options you can find in UniSender API Documentation.

Note

For all methods except importContacts you have to pass parameters as described in UniSender API Documentation.
To call importContacts specify properties field_names and data in another way:
uniSender.importContacts({
	field_names: ['email', 'email_list_ids'],
	data: [
		{ email: 'test1@example.com', email_list_ids: '1, 2, 3' },
		{ email: 'test2@example.com', email_list_ids: '1' },
		{ email: 'test3@example.com', email_list_ids: '3' },
	]
});

They'll be transformed into
field_names[0]=email&field_names[1]=email_list_ids
&data[0][0]=test1@example.com&data[0][1]=1,2,3
&data[1][0]=test2@example.com&data[1][1]=1
&data[2][0]=test3@0example.com&data[2][1]=3