Get the IMAP Config

GET 
/v1/imapbasic/get/:mailer_id

This endpoint gets the IMAP config by mailer_id

Request

Path Parameters

mailer_id stringrequired

Mailer ID

Responses

200

IMAP Config

application/json

Schema

Schema

active boolean
config
config_type string
connection_type string
email string
include_sent boolean
include_spam boolean
include_trash boolean
name string
strict_replies boolean
success boolean

webhook

object

event stringrequired

Possible values: [BASIC_IMAP]

headers object

method stringrequired

Possible values: [GET, POST, PUT, DELETE, PATCH]

webhook_url stringrequired

Example (from schema)

{
  "active": true,
  "config": {},
  "config_type": "string",
  "connection_type": "string",
  "email": "string",
  "include_sent": true,
  "include_spam": true,
  "include_trash": true,
  "name": "string",
  "strict_replies": true,
  "success": true,
  "webhook": {
    "event": "BASIC_IMAP",
    "headers": {},
    "method": "GET",
    "webhook_url": "string"
  }
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

409

Conflict Config Not Found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...