Bots From Extension: email-graph-api
Email Graph API - Read emails and create subscription to Graph API
This extension provides 5 bots.
Bot @graph-api:create-subscription
Bot Position In Pipeline: Source Sink
Create subscription for email messages change notifications
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| minutes | Text | 3600 | Number of minutes to keep subscription active. |
| webhook* | Text | Notification URL |
Bot @graph-api:get-emails-by-id
Bot Position In Pipeline: Sink
Get email messages from message ID
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| id_column | Text | id | Column name in input dataset which contains message ID |
Bot *graph-api:list-subscriptions
Bot Position In Pipeline: Source Sink
List current subscriptions for the mailbox
This bot expects a Full CFXQL.
Bot applies the Query on the data that is already loaded from previous bot or from a source.
Bot @graph-api:mark-unread
Bot Position In Pipeline: Sink
Mark emails as unread within a mailbox
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| id_column | Text | id | Column name in input dataset which contains message ID |
Bot @graph-api:readmail
Bot Position In Pipeline: Source
Get emails from the mailbox
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| fetch_type | Text | unread | To get all emails or only unread emails. Supports all/unread. |
| mark_as_read | Text | no | Mark emails as read at source. Supports yes/no. |
| keep_alive | Text | yes | Keep the session alive after reading all emails. Supports yes/no. |
| filter | Text | Filter the messages. Supports CFXQL filtering. Timestamp filtering can be provided (timestamp is after -24h) |