Skip to main content

IMAP Data Connector

The IMAP Data Connector enables federated SQL query across your emails stored in an IMAP email server.

datasets:
  - from: imap:myawesomeemail@outlook.com
    name: emails
    params:
      imap_access_token: ${secrets:IMAP_ACCESS_TOKEN}

Configuration​

from​

The from field must contain the email address for the mailbox to connect to. For example, me@outlook.com, or jsmith@example.com.

name​

The dataset name. This will be used as the table name within Spice.

Example:

datasets:
  - from: imap:jsmith@example.com
    name: emails
    params: ...
SELECT COUNT(*) FROM emails;
+----------+
| count(*) |
+----------+
| 1234     |
+----------+

params​

The IMAP connector supports the following connection and authentication parameters:

Parameter NameDescription
imap_usernameOptional. The username to use for the IMAP connection. Defaults to the value of the from: mailbox field.
imap_access_tokenOptional. The OAuth access token to use for the IMAP connection, to connect to OAuth-enabled IMAP servers (like Outlook, or Gmail).
imap_passwordOptional. The password to use for the IMAP connection, in plaintext authentication mode.
imap_hostOptional. The host or IP address of the IMAP server to connect to. Not required for known connections like Outlook or Gmail.
imap_portOptional. The port of the IMAP server to connect to.
imap_mailboxOptional. The mailbox to read mail from. Defaults to INBOX, the standard email inbox.
imap_ssl_modeOptional. The IMAP SSL mode to use. Defaults to tls, permitted values of tls, starttls, disabled or auto.

Examples​

Basic example​

datasets:
  - from: imap:jsmith@example.com
    name: emails
    params:
      imap_host: mail.example.com
      imap_password: ${ secrets:IMAP_PASSWORD }

Using OAuth authentication​

datasets:
  - from: imap:jsmith@outlook.com
    name: emails
    params:
      imap_access_token: ${ secrets:IMAP_ACCESS_TOKEN }

Secrets​

Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation. Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide.

Cookbook​