@fimwise/new-email-trigger

@fimwise-trigger/new-email is a Node.js module that provides an email trigger for the Fimwise Bot platform. It allows you to poll for new emails from a specified email provider and trigger actions based on the received emails.

Usage

Define trigger in process configuration

To use this trigger, you need to define it in the process configuration file. The trigger name should be @fimwise-trigger/new-email.

{
  "name": "sample-process",
  "triggers": [
    {
      "name": "@fimwise-trigger/new-email"
    }
  ]
}

Install the package

To install the package, run:

fimwise-bot install path/to/process.json

This command will also install all the dependencies required by the process which also includes the @fimwise-trigger/new-email package.

Configuration

This trigger supports the following configuration options:

• provider: The email provider to use. Currently, only gmail is supported.
• email: The email address to poll for new emails.
• box: The mailbox to poll for new emails. Default is INBOX.
• pollingIntervalInSeconds: The interval in seconds at which the trigger should poll for new emails. Default is 10.
• credentials: The credentials required to authenticate with the email provider. It depends on the email provider you are using.

For gmail, you need to provide the clientId and clientSecret as credentials which obtained from the Google Cloud OAuth 2.0.

License

This project is licensed under the MIT License.