postV1ImapAuth

Connect an account via IMAP/SMTP

  • email
    Type: string
    required
  • first_name
    Type: string
    required
  • last_name
    Type: string
    required
  • provider
    Type: "gmail" or "outlook" or "custom"enum
    required
  • id
    Type: integerFormat: int32

    Signed 32-bit integers (commonly used integer type).

  • imap_server
    Type: string
  • imap_server_password
    Type: string
  • imap_server_port
    Type: integerFormat: int32

    Signed 32-bit integers (commonly used integer type).

  • imap_server_username
    Type: string
  • password
    Type: string
  • smtp_only
    Type: boolean
  • smtp_server
    Type: string
  • smtp_server_auth_type
    Type: string
  • smtp_server_password
    Type: string
  • smtp_server_port
    Type: integerFormat: int32

    Signed 32-bit integers (commonly used integer type).

  • smtp_server_starttls
    Type: boolean
  • smtp_server_username
    Type: string
  • spamchecker_only
    Type: boolean

    If true, the account is connected only for Spam Tests (and automated tests) — warming and monitoring are disabled and no warming seat is charged. Use this when the account is dedicated to running (automated) spam tests.

  • test
    Type: boolean

    Virtual parameter. When true, the endpoint only tests the IMAP/SMTP connection and does not create or update the account.