Set IMAP connection

Save IMAP connection settings for the authenticated user and validate connectivity.

post/api/v1/imap/connection

Request

  • Base URL: https://localhost:3000
  • URL: https://localhost:3000/api/v1/imap/connection
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token)

Request body

presetstring

Optional preset: icloud, gmail, outlook, yahoo, custom

hoststring

Required for custom preset

portinteger
usernamestring required
passwordstring required
use_sslboolean

Response

Connection saved

configuredboolean
connector_idstring
session_userstring
credential_identitystring nullable
hoststring nullable
portinteger nullable
usernamestring nullable
use_sslboolean nullable
password_setboolean
sourcestring nullable

Example response

{
  "connector_id": "imap",
  "source": "user"
}

Changes

No recorded changes to this operation across all 1 revision of this API.