Email Microservice

This is a email sending microservice from Pip.Services library. This microservice is intended mostly to send emails to registered users as well as orbitrary recipients. Users have ability to enable or disable certain subcription types. In the current version email attachments are not supported.

The microservice currently supports the following deployment options:

• Deployment platforms: Standalone Process, Seneca
• External APIs: HTTP/REST, Seneca

This microservice has optional dependencies on the following microservices:

• pip-services-activities - to log user activities

Quick Links:

• Download Links
• Development Guide
• Configuration Guide
• Deployment Guide
• Client SDKs
  • Node.js SDK
• Communication Protocols
  • HTTP Version 1
  • Seneca Version 1

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class MessageV1 {
    public from: string;
    public cc: string;
    public bcc: string;
    public to: string;
    public reply_to: string;
    public subject: string;
    public text: string;
    public html: string;
}

class RecipientV1 {
    public id: string;
    public name: string;
    public email: string;
    public language: string;
}

class EmailSettingsV1 implements IStringIdentifiable {
    /* Recipient information */
    public id: string;
    public name: string;
    public email: string;
    public language: string;

    /* Email management */
    public subscriptions: any;
    public verified: boolean;
    public ver_code: string;
    public ver_expire_time: Date;

    /* Custom fields */
    public custom_hdr: any;
    public custom_dat: any;
}

interface IEmailV1 {
    getSettingsById(correlationId: string, recipientId: string,
        callback: (err: any, settings: EmailSettingsV1) => void): void;

    getSettingsByEmail(correlationId: string, email: string,
        callback: (err: any, settings: EmailSettingsV1) => void): void;

    setSettings(correlationId: string, settings: EmailSettingsV1,
        callback?: (err: any, settings: EmailSettingsV1) => void): void;

    setRecipient(correlationId: string, recipientId: string,
        name: string, email: string, language: string,
        callback?: (err: any, settings: EmailSettingsV1) => void): void;

    setSubscriptions(correlationId: string, recipientId: string, subscriptions: any,
        callback?: (err: any, settings: EmailSettingsV1) => void): void;

    deleteSettingsById(correlationId: string, recipientId: string,
        callback?: (err: any) => void): void;

    sendMessage(correlationId: string, message: MessageV1, parameters: ConfigParams,
        callback?: (err: any) => void): void;

    sendMessageToRecipient(correlationId: string, recipient: RecipientV1, subscription: string,
        message: MessageV1, parameters: ConfigParams, callback?: (err: any) => void);

    sendMessageToRecipients(correlationId: string, recipients: RecipientV1[], subscription: string,
        message: MessageV1, parameters: ConfigParams, callback?: (err: any) => void): void;

    resendVerification(correlationId: string, recipientId: string,
        callback?: (err: any) => void): void;

    verifyEmail(correlationId: string, recipientId: string, code: string,
        callback?: (err: any) => void): void;
}

Message subject, text and html content can be set by template, that it processed using parameters set. Here is an example of the template:

Dear <%= name %>,
<p/>
Please, help us to verify your email address. Your verification code is <%= code %>.
<p/>
Click on the 
<a href="<%= clientUrl %>/#/verify_email?server_url=<%= serverUrl %>&email=<%= email %>&code=<%= code %>">link</a>
to complete verification procedure
<p/>
---<br/>
<%= signature %>

Download

Right now the only way to get the microservice is to check it out directly from github repository

git clone git@github.com:pip-services-users/pip-services-email-node.git

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Run

Add config.yaml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yaml file. Example of microservice configuration ```yaml

• descriptor: "pip-services-commons:logger:console:default:1.0" level: "trace"

• descriptor: "pip-services-email:persistence:file:default:1.0" path: "./data/email_settings.json"

• descriptor: "pip-services-email:controller:default:default:1.0" message: from: 'somebody@somewhere.com' to: 'somebody@somewhere.com' connection: service: 'Gmail' host: 'smtp.gmail.com' secure_connection: true port: 465 credential: username: 'somebody@gmail.com' password: 'pass123'

• descriptor: "pip-services-email:service:http:default:1.0" connection: protocol: "http" host: "0.0.0.0" port: 8080

 
For more information on the microservice configuration see [Configuration Guide](Configuration.md).

Start the microservice using the command:
```bash
node run

Use

The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

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

Inside your code get the reference to the client SDK

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

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.EmailHttpClientV1(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'
    },
    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'
    },
    function (err) {
        ...
    }
);

Acknowledgements

This microservice was created and currently maintained by Sergey Seroukhov.