pip_services_email 1.1.1

Email Delivery microservice for Pip.Services in Dart. This microservice sends emails to specified recipients.

example/README.md

Examples for Email Delivery Microservice

This is email microservice from Pip.Services library. It keeps a list of supported email that are referenced from other content microservices.

Define configuration parameters that match the configuration of the microservice's external API

// Service/Client configuration
var httpConfig = ConfigParams.fromTuples([
    "connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080
]);

Instantiate the service

controller = EmailController();
controller.configure(ConfigParams());

service = EmailHttpServiceV1();
service.configure(httpConfig);

var references = References.fromTuples([
    Descriptor('pip-services-email', 'controller', 'default',
        'default', '1.0'),
    controller,
    Descriptor(
        'pip-services-email', 'service', 'http', 'default', '1.0'),
    service
]);

controller.setReferences(references);
service.setReferences(references);

await controller.open(null);
await service.open(null);

Instantiate the client and open connection to the microservice

// Create the client instance
var client = EmailHttpClientV1(config);

// Configure the client
client.configure(httpConfig);

// Connect to the microservice
try{
  await client.open(null)
}catch() {
  // Error handling...
}       
// Work with the microservice
// ...

Now the client is ready to perform operations

// Send email message to address
var message = EmailMessageV1(to: '[e-mail]', 
                             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
);

// Send email message to users
var recipient1 = EmailRecipientV1(id: '1', email: '[e-mail]');
var recipient2 = EmailRecipientV1(id: '2', email: '[e-mail]');
var message = EmailMessageV1(subject: 'Test', 
                             text: 'This is a test message. Please, ignore it');
await client.sendMessageToRecipients(
    null,
    [
        recipient1,
        recipient2
    ],
    message,
    null
);

In the help for each class there is a general example of its use. Also one of the quality sources are the source code for the tests.