packages/docs/plugin-registry/platform/gmail-watch.md
The Gmail Watch plugin connects Eliza agents to Gmail, enabling monitoring of incoming emails and automated responses.
Package: @elizaos/plugin-gmail-watch
Note: Gmail Watch is categorized as a feature plugin in the registry, not a connector. It provides Gmail Pub/Sub message watching and auto-renewal.
eliza plugins install @elizaos/plugin-gmail-watch
The Gmail Watch plugin is activated via the features.gmailWatch flag in your Eliza configuration:
{
"features": {
"gmailWatch": true
}
}
Follow the Google Cloud Console setup to enable the Gmail API and obtain OAuth credentials for your agent.
Gmail Watch is configured via both a feature flag and the hooks.gmail section:
| Field | Required | Description |
|---|---|---|
features.gmailWatch | Yes | Set true to enable the Gmail Watch plugin |
hooks.gmail.account | Yes | Gmail address to monitor |
hooks.gmail.label | No | Gmail label to watch (default: "INBOX") |
hooks.gmail.includeBody | No | Include email body content in agent events |
{
"features": {
"gmailWatch": true
},
"hooks": {
"enabled": true,
"gmail": {
"account": "[email protected]",
"label": "INBOX",
"includeBody": true
}
}
}