diff --git a/resources/docs/Labels.md b/resources/docs/Labels.md index 87d5ac630..04f3ef019 100755 --- a/resources/docs/Labels.md +++ b/resources/docs/Labels.md @@ -15,4 +15,6 @@ You can easily (de)assign label to messages in message viewer. -Note that (de)assignments of labels to messages are synchronized back to supported servers in regular intervals. \ No newline at end of file +Note that (de)assignments of labels to messages are synchronized back to supported servers in regular intervals. + +Also, [message filters](Message-filters.md) can assign or remove labels to/from messages. \ No newline at end of file diff --git a/resources/docs/Message-filters.md b/resources/docs/Message-filters.md index 78f7192a7..c6b32e374 100755 --- a/resources/docs/Message-filters.md +++ b/resources/docs/Message-filters.md @@ -13,11 +13,17 @@ As you can see, RSS Guard processes all feeds scheduled for message downloading ## Writing message filter -Message filter consists of arbitrary JavaScript code which must provide function with prototype `function filterMessage() { }`. This function must be fast and must return integer values which belong to enumeration [`FilteringAction`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L83). For example, your function must return `2` to block the message which is subsequently NOT saved into database. For easier usage, RSS Guard 3.7.1+ offers named variables for this, which are called `MSG_ACCEPT` and `MSG_IGNORE`. +Message filter consists of arbitrary JavaScript code which must provide function with prototype -Each message is accessible in your script via global variable named `msg` of type [`MessageObject`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L118). Some properties are writable, thus allowing you to change contents of the message before it is written to DB. You can mark message important, parse its description or perhaps change author name!!! +```js +function filterMessage() { } +``` -RSS Guard 3.8.0+ offers also read-only list of labels assigned to each message. You can therefore do actions in your filtering script based on which labels are assigned to the message. The property is called `assignedLabels` and is array of `Label` objects. Each `Label` in the array offers these properties: `title` (title of the label), `color` (color of the label) and `customId` (account-specific ID of the label). +This function must be fast and must return integer values which belong to enumeration [`FilteringAction`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L83). For example, your function must return `2` to block the message which is subsequently NOT saved into database. For easier usage, RSS Guard 3.7.1+ offers named variables for this, which are called `MSG_ACCEPT` and `MSG_IGNORE`. + +Each message is accessible in your script via global variable named `msg` of type [`MessageObject`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L118). Some properties are writable, allowing you to change contents of the message before it is written to DB. You can mark message important, parse its description or perhaps change author name or even assign some label to it!!! + +RSS Guard 3.8.0+ offers also list of labels assigned to each message. You can therefore do actions in your filtering script based on which labels are assigned to the message. The property is called `assignedLabels` and is array of `Label` objects. Each `Label` in the array offers these properties: `title` (title of the label), `color` (color of the label) and `customId` (account-specific ID of the label). If you change assigned labels to the message, then the change will be eventually synchronized back to server if respective plugin supports it. Passed message also offers special function ```js @@ -27,6 +33,35 @@ which allows you to perform runtime check for existence of the message in RSS Gu For example if you want to check if there is already another message with same author in database, then you call `msg.isDuplicateWithAttribute(4)`. Enumeration even supports "flags" approach, thus you can combine multiple checks via bitwise `OR` operation in single call, for example like this: `msg.isDuplicateWithAttribute(4 | 16)`. +## API reference +Here is the reference of methods and properties of some types available in your filtering scipts. + +### `MessageObject` + +| Property/method | Description | +|---|---| +| `array