Mandrill Open Microservice
Wrapper for the Mandrill API
Introduction
This project is an example implementation of the Open Microservice Specification, a standard originally created at Storyscript for building highly-portable "microservices" that expose the events, actions, and APIs inside containerized software.
Getting Started
The oms command-line interface allows you to interact with Open Microservices. If you're interested in creating an Open
Microservice the CLI also helps validate, test, and debug your oms.yml implementation!
See the oms-cli project to learn more!
Installation
npm install -g @microservices/oms
Usage
Open Microservices CLI Usage
Once you have the oms-cli installed, you can run any of the following commands from within this project's root directory:
Actions
send
Send email
Action Arguments
| Argument Name | Type | Required | Default | Description |
|---|---|---|---|---|
| from | string |
true |
None | The sender email address. |
| to | string |
true |
None | The receiver email address |
| subject | string |
false |
None | The subject of email |
| message | string |
true |
None | The message body of email |
| templateName | string |
true |
None | The template of email |
| API_KEY | string |
true |
None | API Key of Mandrill |
oms run send \
-a from='*****' \
-a to='*****' \
-a subject='*****' \
-a message='*****' \
-a templateName='*****' \
-e API_KEY=$API_KEYContributing
All suggestions in how to improve the specification and this guide are very welcome. Feel free share your thoughts in the Issue tracker, or even better, fork the repository to implement your own ideas and submit a pull request.
This project is guided by Contributor Covenant. Please read out full Contribution Guidelines.
Additional Resources
- Install the CLI - The OMS CLI helps developers create, test, validate, and build microservices.
- Example OMS Services - Examples of OMS-compliant services written in a variety of languages.
- Example Language Implementations - Find tooling & language implementations in Node, Python, Scala, Java, Clojure.
- Storyscript Hub - A public registry of OMS services.
- Community Chat - Have ideas? Questions? Join us on Spectrum.