IMAP Connection

The IMAP connection type enables integrations with the IMAP client.

Authenticating to IMAP

Authenticate to the IMAP client with the login and password field. Use standard IMAP authentication

Default Connection IDs

Hooks, operators, and sensors related to IMAP use imap_default by default.

Configuring the Connection


Specify the username used for the IMAP client.


Specify the password used for the IMAP client.


Specify the IMAP host url.


Specify the IMAP port to connect to. The default depends on the whether you use ssl or not.

Extra (optional)

Specify the extra parameters (as json dictionary)

  • use_ssl: If set to false, then a non-ssl connection is being used. Default is true. Also note that changing the ssl option also influences the default port being used.

  • ssl_context: Can be “default” or “none”. Only valid when “use_ssl” is used. The “default” context provides a balance between security and compatibility, “none” is not recommended as it disables validation of certificates and allow MITM attacks and is only needed in case your certificates are wrongly configured in your system. If not specified, defaults are taken from the “imap”, “ssl_context” configuration with the fallback to “email”. “ssl_context” configuration. If none of it is specified, “default” is used.

When specifying the connection in environment variable you should specify it using URI syntax.

Note that all components of the URI should be URL-encoded.

For example:


Another example for connecting via a non-SSL connection.


Note that you can set the port regardless of whether you choose to use ssl or not. The above examples show default ports for SSL and Non-SSL connections.

Was this entry helpful?