pip_services_email

Description:

pip services email

Email Delivery Microservice #
This is a email delivery microservice from Pip.Services library.
This microservice sends emails to specified recipients.
The microservice currently supports the following deployment options:

Deployment platforms: Standalone Process
External APIs: HTTP/REST

Quick Links:

Download Links
Development Guide
Configuration Guide
Deployment Guide
Client SDKs

Dart SDK


Communication Protocols

HTTP 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 EmailMessageV1 {
String from;
String cc;
String bcc;
String to;
String reply_to;
dynamic subject;
dynamic text;
dynamic html;
}

class EmailRecipientV1 {
String id;
String name;
String email;
String language;
}

abstract class IEmailV1 {
Future sendMessage(String? correlationId, EmailMessageV1 message, ConfigParams parameters);

Future sendMessageToRecipient(String? correlationId, EmailRecipientV1 recipient, EmailMessageV1 message, ConfigParams parameters);

Future sendMessageToRecipients(String? correlationId, List<EmailRecipientV1> recipients, EmailMessageV1 message, ConfigParams parameters);
}
copied to clipboard
Message subject, text and html content can be set by handlebars 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 }}
copied to clipboard
Download #
Right now the only way to get the microservice is to check it out directly from github repository
git clone [email protected]:pip-services-infrastructure/pip-services-email-dart.git
copied to clipboard
Pip.Service team is working to implement packaging and make stable releases available for your
as zip downloadable archieves.
Run #
Add config.yml file to the root of the microservice folder and set configuration parameters.
As the starting point you can use example configuration from config.example.yml file.
Example of microservice configuration
---
- descriptor: "pip-services-commons:logger:console:default:1.0"
level: "trace"

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

- descriptor: "pip-services-email:service:http:default:1.0"
connection:
protocol: "http"
host: "0.0.0.0"
port: 8080
copied to clipboard
For more information on the microservice configuration see Configuration Guide.
Start the microservice using the command:
dart ./bin/run.dart
copied to clipboard
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 dart, then get references to the required libraries:

Pip.Services3.Commons : https://github.com/pip-services3-dart/pip-services3-commons-dart
Pip.Services3.Rpc: https://github.com/pip-services3-dart/pip-services3-rpc-dart

Add pip-services3-commons-dart, pip-services3-rpc-dart and pip-services_email packages
import 'package:pip_services3_commons/pip_services3_commons.dart';
import 'package:pip_services3_rpc/pip_services3_rpc.dart';

import 'package:pip_services_email/pip_services_email.dart';

copied to clipboard
Define client configuration parameters that match configuration of the microservice external API
// Client configuration
var config = ConfigParams.fromTuples(
"connection.protocol", "http",
"connection.host", "localhost",
"connection.port", 8080
);
copied to clipboard
Instantiate the client and open connection to the microservice
// Create the client instance
var client = EmailHttpClientV1(config);

// Connect to the microservice
await client.open(null);

// Work with the microservice
...
});
copied to clipboard
Now the client is ready to perform operations
// Send email message to address
var message = EmailMessageV1(to: '[email protected]',
subject: 'Test',
text: 'This is a test message. Please, ignore it');
var parameters = ConfigParams.fromTuples(
['subject', 'Test Email To Address', 'text', 'This is just a test']);

await client.sendMessage(
null,
message,
parameters
);
copied to clipboard
// Send email message to users
var recipient1 = EmailRecipientV1(id: '1', email: '[email protected]');
var recipient2 = EmailRecipientV1(id: '2', email: '[email protected]');
var message = EmailMessageV1(subject: 'Test',
text: 'This is a test message. Please, ignore it');
await client.sendMessageToRecipients(
null,
[
recipient1,
recipient2
],
message,
null
);
copied to clipboard
Acknowledgements #
This microservice was created and currently maintained by

Sergey Seroukhov
Denis Kuznetsov
Nuzhnykh Egor.