UNPKG

pip-services-email-node

Version:
86 lines (68 loc) 2.78 kB
# Configuration Guide <br/> Email Delivery Microservice Email delivery microservice configuration structure follows the [standard configuration](https://github.com/pip-services/pip-services3-container-node/doc/Configuration.md) structure. * [controller](#controller) * [service](#service) - [http](#service_http) - [seneca](#service_seneca) ## <a name="controller"></a> Controller Controller has the following configuration properties: - message: hashmap - Message default properties - from: string - sender address - cc: string - CC address - to: string - default recipient address - reply_to: string - Reply-To address - connection: ConnectionParams - SMTP connection parameters - credential: CredentialParams - SMTP credentials Example: ```yaml - 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' ``` ## <a name="service"></a> Services The **service** components (also called endpoints) expose external microservice API for the consumers. Each microservice can expose multiple APIs (HTTP/REST, Thrift or Seneca) and multiple versions of the same API type. At least one service is required for the microservice to run successfully. ### <a name="service_http"></a> Http HTTP/REST service has the following configuration properties: - connection: object - HTTP transport configuration options - protocol: string - HTTP protocol - 'http' or 'https' (default is 'http') - host: string - IP address/hostname binding (default is '0.0.0.0') - port: number - HTTP port number A detailed description of HTTP protocol version 1 can be found [here](HttpProtocolV1.md) Example: ```yaml - descriptor: "pip-services-email:service:http:default:1.0" connection: protocol: "http" host: "0.0.0.0" port: 3000 ``` ### <a name="service_seneca"></a> Seneca Seneca service has the following configuration properties: - connection: object - Seneca transport configuration options. See http://senecajs.org/api/ for details. - type: string - Seneca transport type - host: string - IP address/hostname binding (default is '0.0.0.0') - port: number - Seneca port number A detail description of Seneca protocol version 1 can be found [here](SenecaProtocolV1.md) Example: ```yaml - descriptor: "pip-services-email:service:seneca:default:1.0" connection: protocol: "http" host: "0.0.0.0" port: 3000 ``` For more information on this section read [Pip.Services Configuration Guide](https://github.com/pip-services/pip-services3-container-node/doc/Configuration.md#deps)