Skip to main content

Email Inbox (IMAP)

Poll a mailbox over IMAP and ingest each forwarded alert email as an event. Pairs with the /v1/inbox/email webhook for environments that cannot push directly.

  • Connector id: email_inbox
  • Category: saas

Configuration​

FieldLabelTypeRequiredDefaultNotes
hostIMAP hoststringyes——
portIMAP portnumberno993Defaults to 993 (IMAPS).
usernameUsernamestringyes——
passwordPassword / App Passwordsecretyes—encrypted at rest · Use an app-specific password for Gmail / Outlook. Never your primary account password.
mailboxMailbox / folderstringnoINBOX—
max_messagesMax messages per pollnumberno50Cap how many unread messages we pull per poll. Older unread messages will still arrive — they'll just take more polls to drain.
use_sslUse SSL (IMAPS)booleannoTrue—
Credential handling

password is encrypted at rest by the credential vault before the row is written, and decrypted only at poll time. The value is never logged and never returned by the API — a read of the saved connector shows the field as set, not its contents. See credential vault.

Setup​

  1. In the console, go to Connectors → Add connector and pick Email Inbox (IMAP).
  2. Fill in the fields above and run Test connection. The test is read-only and does not save anything.
  3. Save. Polling starts on a jittered schedule within about a minute; the connector row shows last_sync once the first poll completes.
If last_sync stays empty

The first poll is the honest signal that the credential works. A connector that saves cleanly and never syncs usually means the credential lacks a scope the vendor requires for reads — check the connectors service log for the vendor's own error, which is passed through verbatim rather than summarised.

Vendor-specific setup notes go here: which console page issues the credential, which scopes to grant, rate limits, and anything the schema cannot express. This section is preserved when the page is regenerated.