@runnerty/notifier-mail
v3.2.1
Published
Runnerty module: Mail notifier
Downloads
49
Readme
Mail notifier for Runnerty:
Email notification module with ejs template support.
Installation:
Through NPM
npm i @runnerty/notifier-mail
You can also add modules to your project with runnerty
npx runnerty add @runnerty/executor-mysql
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:
runnerty add @runnerty/executor-mysql
Configuration sample:
Add in config.json:
{
"notifiers": [
{
"id": "mail_default",
"type": "@runnerty-notifier-mail",
"disable": false,
"from": "Runnerty <[email protected]>",
"transport": "smtps://my%40mail.com:[email protected]/?pool=true",
"templateDir": "/etc/runnerty/templates",
"template": "alerts",
"to": ["[email protected]"],
"ejsRender": true
}
]
}
{
"notifiers": [
{
"id": "mail_default",
"type": "@runnerty-notifier-mail",
"disable": false,
"from": "Runnerty <[email protected]>",
"to": ["NAME <[email protected]>"],
"transport": {
"host": "smtp.mailhost.com",
"port": 465,
"secure": true,
"auth": {
"user": "USER_SAMPLE",
"pass": "PASS_SAMPLE"
}
},
"templateDir": "templates",
"template": "template_one",
"attachments": [
{
"filename": "runnerty.png",
"path": "templates/imgs/runnerty.png",
"cid": "[email protected]"
}
],
"ejsRender": true,
"maxConcurrents": 2,
"minInterval": 25
}
]
}
To use AWS SES transport:
{
"notifiers": [
{
"id": "mail_aws_ses_role",
"type": "@runnerty-notifier-mail",
"from": "Runnerty <[email protected]>",
"to": ["Support <[email protected]>"],
"transport": {
"service": "SES",
"region": "us-east-1",
"ses": {
// optional extra arguments for SendRawEmail
"Tags": [
{
"Name": "tag_name",
"Value": "tag_value"
}
]
}
},
"templateDir": "templates",
"template": "mail-notification",
"ejsRender": true
}
]
Plan sample:
Add in plan.json:
{
"notifications": {
"on_fail": [
{
"id": "mail_error",
"subject": "ERROR - PROCESS @GV(PROCESS_ID) CHAIN @GV(CHAIN_ID)",
"message": "CMD:<br> @GV(PROCESS_EXEC_COMMAND_EXECUTED)<br>ERROR:<br>@GV(PROCESS_EXEC_ERR_OUTPUT)"
}
]
}
}