pip_clients_email 1.1.0 copy "pip_clients_email: ^1.1.0" to clipboard
pip_clients_email: ^1.1.0 copied to clipboard

Clients for 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 a user account management microservice from Pip.Services library.

  • Registers users and creates their accounts
  • Keeps key user descriptions and settings (about, location, language, theme, ...)

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

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

Instantiate the client and open connection to the microservice

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

// 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: 'somebody@somewhere.com',
            subject: '{{subject}}',
            text: '{{text}}',
            html: '<p>{{text}}</p>');

        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: 'user1@somewhere.com');
var recipient2 = EmailRecipientV1(id: '2', email: 'user2@somewhere.com');
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.

0
likes
140
points
47
downloads

Publisher

verified publisherentinco.com

Weekly Downloads

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

Homepage

Documentation

API reference

License

MIT (license)

Dependencies

http, pip_services3_commons, pip_services3_components, pip_services3_data, pip_services3_rpc, pip_services_email

More

Packages that depend on pip_clients_email