Smart Processes Management

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]

Mail executor for [Runnerty]:

Email notification module with [ejs] template support.

$3

``bash
npm i @runnerty/executor-mail
`

You can also add modules to your project with [runnerty]

`bash
npx runnerty add @runnerty/executor-mail
`

This command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.

If you have installed [runnerty] globally you can include the module with this command:

`bash
runnerty add @runnerty/executor-mail
`

$3

Add in [config.json]:

`json
{
"id": "mail_default",
"type": "@runnerty-executor-mail",
"disable": false,
"from": "Runnerty Notificator ",
"transport": "smtp://my%mailsender.com:pass@smtp.host.com/?pool=true",
"bcc": ["mycc@mail.com"],
"templateDir": "/etc/runnerty/templates",
"template": "alerts",
"ejsRender": true
}
`

`json
{
"id": "mail_aws_ses_iam_smtp",
"type": "@runnerty-executor-mail",
"disable": false,
"from": "Runnerty ",
"transport": {
"host": "email-smtp.eu-west-1.amazonaws.com",
"port": 465,
"secure": true,
"auth": {
"user": "aws_ses_user",
"pass": "aws_ses_pass"
}
},
"templateDir": "/etc/runnerty/templates",
"template": "alerts",
"ejsRender": true
}
`

To use AWS SES [transport]:

`json
{
"id": "mail_aws_ses_role",
"type": "@runnerty-executor-mail",
"from": "Runnerty ",
"transport": {
"service": "SES",
"region": "us-east-1",
"ses": {
// optional extra arguments for SendRawEmail
"Tags": [
{
"Name": "tag_name",
"Value": "tag_value"
}
]
}
},
"templateDir": "/etc/runnerty/templates",
"template": "alerts",
"ejsRender": true
}
`

$3

Add in [plan.json]:

`json
{
"id": "mail_default",
"to": ["my@mail.com"],
"title": "Runnerty Mailer",
"message": "My message from Runnerty!",
"attachments": [
{
"filename": "sample.png",
"path": "/etc/runnerty/templates/alerts/images/sample.png",
"cid": "img_name@sample.png"
}
]
}
`

$3

#### Plan:

`json
{
"id": "mail_default",
"to": ["my@mail.com"],
"title": "Runnerty Mailer",
"message": "My message from Runnerty!",
"args": { "value_one": "Hello", "value_two": "world!", "value_three": ":YYYY" }
}
`

#### HTML Template:

`html





<%= value_three %>


``

Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
guidelines for [contributing][contributing].

[contributing]: https://github.com/runnerty/runnerty/blob/master/CONTRIBUTING.md
[runnerty]: https://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-mail.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-mail
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-mail.svg
[david-badge]: https://david-dm.org/runnerty/executor-mail.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-mail
[config.json]: http://docs.runnerty.io/config/
[plan.json]: http://docs.runnerty.io/plan/
[transport]: https://nodemailer.com/transports/ses/
[ejs]: https://ejs.co