Plugins
Input plugins
stdin
Subscription in STDIN.
Parameters
none
Example
"stdin": {}
ical
Subscription in iCal format.
Parameters
Name | parameter |
---|---|
url | ICS file by adding an URL. |
within | The schedule for less than n hour is searched. |
Example
"ical": {
"url"; "http://..../foo.ics",
"within": "6"
}
mysql
Subscription in MySQL.
Parameters
Name | parameter |
---|---|
settings | MySQL connection settings. |
query | Executing SQL statements and queries. |
target | Fetch target column. |
Example
"mysql": {
"settings": {
"host": "host_name",
"database": "database_name",
"user": "mysql_user",
"password": "mysql_pw"
},
"query": "select count(*) as count from users;",
"target": "count"
}
rss
Subscription in RSS.
Parameters
Name | parameter |
---|---|
url | Feed URL. |
uniqueness | Uniqueness |
format | Passed subscription format. |
Example
"rss": {
"url": "http://feeds.feedburner.com/hideack?format=xml",
"format": "__description__\n__link__",
"uniqueness": "Update:.*"
}
staticword
A text is passed as it is.
Parameters
Name | parameter |
---|---|
text | Message passed to a filter. |
Example
"staticWord": {
"text": "test word."
}
webpageparser
Use CSS path to extract subscription from web page.
Parameters
Name | parameter |
---|---|
url | Web page URL. |
target | CSS path. |
Example
"webPageParse": {
"url": "https://github.com/hideack/evac",
"target" : "#count"
}
Filter plugins
diff
This plugin applies diff to each entry body.
Parameters
Name | parameter |
---|---|
bufferName | A buffer name is specified. |
Example
"diff": {
"bufferName": "sample-buffer"
}
match
This plug-in outputs the character string applicable to a regular expression.
Parameters
Name | parameter |
---|---|
regexp | Regular expression. |
Example
"match": {
"regexp": "\\d\\d.\\d\\s%"
}
through
This plugin processes nothing.
Parameters
none
Example
"through": {}
Output plugins
httppost
Parameters
Name | parameter |
---|---|
url | Post URL is specified. |
body | Body |
Example
It describes as follows to transmit by application/x-www-form-urlencoded.
"httpPost": {
"url": "http://requestb.in/12345",
"body": {
"form": {"auth_token": "secret_foo", "value": "__word__"}
}
}
It describes as follows to transmit by application/json.
"httpPost": {
"url": "http://requestb.in/12345",
"body": {
"json": {"auth_token": "secret_foo", "value": "__word__"}
}
}
ikachan
This plugin allows you to notify feed updates to IRC channels.
Parameters
Name | parameter |
---|---|
url | Ikachan URL. |
channel | The channel which participates is specified. |
message | The message notified by IRC. word is replaced by passed words. |
Example
"ikachan": {
"url": "http://....",
"channel": "#evac",
"message": "Output is __word__ "
}
Parameters
Name | parameter |
---|---|
from | Sender address |
to | Delivery address |
subject | Mail subject |
Example
"mail": {
"from": "hideack99@gmail.com",
"to": "hideack99@gmail.com",
"subject": "evac test mail"
}
notice
Parameters
Name | parameter |
---|---|
type | Notification type. |
title | Notification title. |
Example
"notice": {
"type": "growl",
"title": "テスト"
}
shell
An output is passed to shell and it evaluates as a command.
Parameters
Name | parameter |
---|---|
command | word is replaced by passed word. |
Example
"shell": {
"command": "echo __word__"
}
stdout
Out to stdout.
Parameters
none
Example
"stdout": {}
yo
Out to Yo.
Parameters
Name | parameter |
---|---|
token | Yo API Token. (http://yoapi.justyo.co/ ) |
Example
"yo": {
"token": "xxxxx-yyyy-zzzz-aaaa-bbbbbbbbb"
}
pushbullet
Out to Pushbullet.
Parameters
Name | parameter |
---|---|
device | Target device. |
token | Pushbullet access token. https://www.pushbullet.com/account |
title | Push title. |
mode | “note” or “link” |
Example
"pushbullet": {
"device": "*****@gmail.com",
"token" : "*****",
"title": "test",
"mode": "link"
}
slack
Out to slack.
Parameters
Name | parameter |
---|---|
url | Webhook URL |
Example
"slack": {
"url": "https://hooks.slack.com/services/T02*****/B03******/cZ98******"
}