Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

pip-clients-email-node

1.0.3 • Public • Published

Email Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-email microservice. It provides an easy to use abstraction over communication protocols:

  • HTTP client
  • Seneca client (see http://www.senecajs.org)
  • Direct client for monolythic deployments
  • Null client to be used in testing

In addition to the microservice functionality the client SDK supports message templates that can be configured by client user.

Quick Links:

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-email-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies 
npm install
 
# Update already installed dependencies 
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-email-node');

Define client configuration parameters.

// Client configuration
var config = {
    parameters: {
        server_url: 'http://localhost:3000',
        client_url: 'http://localhost:8000',
        client_name: 'PipServices Sample',
        welcome_message: 'Congratulations with your signup in <%= clientName %>!',
        signature: 'Sincerely, <%= clientName %> Team'
    },
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.EmailRestClient(config);
 
// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Send email message to address
client.sendMessage(
    null,
    { 
        to: 'somebody@somewhere.com',
        subject: 'Test',
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);
// Send email message to users
client.sendMessageToRecipients(
    null,
    [
        { id: '123' },
        { id: '321' }
    ],
    'test',
    { 
        subject: 'Test',
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);

To use templates for sent messages you need to put template files under configured template folder. Inside template you shall use <%= property %> syntax to insert properties from provided content defined in client configuration and request parameters.

Example of message.txt template

Hello <%= user_name %>!
 
This is a test message from <%= client_name %> sent on <%= today %>.
Please, ignore it.

Example of message.html template

Hello <%= user_name %>!
<p>
This is a test message from <%= client_name %> sent on <%= today %>. 
<br/>
Please, ignore it.
</p>

Now you can send a message using the templates stored in files. subjectTemplate, textTemplate and htmlTemplate parameters shall contain the template file paths. Client will automatically load their content and parse.

// Send email message to address using template
client.sendMessage(
    null,
    { 
        to: 'somebody@somewhere.com',
        subject: fs.readFromFileSync('./templates/message_subject.txt', 'utf8'),
        text: fs.readFromFileSync('./templates/message.txt', 'utf8'),
        html: fs.readFromFileSync('./templates/message.html', 'utf8'),
    },
    {
        user_name: 'Somebody',
        today: new Date.toISOString()
    },
    function (err) {
        ...
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.

Install

npm i pip-clients-email-node

DownloadsWeekly Downloads

8

Version

1.0.3

License

MIT

Unpacked Size

197 kB

Total Files

89

Last publish

Collaborators

  • avatar