-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1adf8cc
commit b4dd491
Showing
10 changed files
with
494 additions
and
512 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
#IDE | ||
.vscode | ||
# | ||
api | ||
node_modules | ||
samples | ||
*.md | ||
*.json | ||
.DS_Store | ||
.npmignore | ||
LICENSE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
node_modules | ||
.all-contributorsrc | ||
.eslintignore | ||
.gitignore | ||
.prettierignore | ||
.DS_Store | ||
LICENSE | ||
*.png | ||
*.txt | ||
TODO | ||
.npmignore | ||
docs/functions.md | ||
*.md | ||
test.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
{ | ||
"printWidth": 120, | ||
"singleQuote": false, | ||
"singleQuote": true, | ||
"useTabs": false, | ||
"tabWidth": 2, | ||
"semi": true, | ||
"bracketSpacing": true | ||
"bracketSpacing": true, | ||
"trailingComma": "none", | ||
"arrowParens": "avoid" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,26 @@ | ||
<p align="center"> | ||
<a href="http://runnerty.io"> | ||
<img height="257" src="https://runnerty.io/assets/header/logo-stroked.png"> | ||
</a> | ||
<p align="center">A new way for processes managing</p> | ||
</p> | ||
|
||
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url] | ||
<a href="#badge"> | ||
<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"> | ||
</a> | ||
|
||
|
||
# Mail notifier for [Runnerty]: | ||
Email notification module with [ejs] template support. | ||
|
||
### Configuration sample: | ||
### Installation: | ||
```bash | ||
npm i @runnerty/notifier-mail | ||
``` | ||
|
||
### Configuration sample: | ||
Add in [config.json]: | ||
```json | ||
{ | ||
"id": "mail_default", | ||
|
@@ -15,9 +34,39 @@ | |
"ejsRender": true | ||
} | ||
``` | ||
```json | ||
{ | ||
"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 | ||
} | ||
``` | ||
|
||
### Plan sample: | ||
|
||
Add in [plan.json]: | ||
```json | ||
{ | ||
"id": "mail_default", | ||
|
@@ -26,4 +75,12 @@ | |
} | ||
``` | ||
|
||
[runnerty]: http://www.runnerty.io | ||
[Runnerty]: http://www.runnerty.io | ||
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/notifier-mail.svg | ||
[npm-url]: https://www.npmjs.com/package/@runnerty/notifier-mail | ||
[npm-image]: https://img.shields.io/npm/v/@runnerty/notifier-mail.svg | ||
[david-badge]: https://david-dm.org/runnerty/notifier-mail.svg | ||
[david-badge-url]: https://david-dm.org/runnerty/notifier-mail | ||
[config.json]: http://docs.runnerty.io/config/ | ||
[plan.json]: http://docs.runnerty.io/plan/ | ||
[ejs]: https://ejs.co |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.