ConnectorController

Create an inbox connector IMAP connection

Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

post/connectors/{id}/imap

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/connectors/{id}/imap
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

Request body

imapSslboolean nullable
imapUsernamestring nullable
imapPasswordstring nullable
selectFolderstring nullable

Optional folder to select during IMAP connection

searchTermsstring nullable
imapPortinteger nullable

IMAP server port

imapHoststring required

IMAP server host

enabledboolean nullable

IMAP server enabled

startTlsboolean nullable
proxyEnabledboolean nullable
proxyPortinteger nullable
proxyHoststring nullable
localHostNamestring nullable
mechanismsstring[] nullable

List of IMAP mechanisms

sslTruststring nullable
sslProtocolsstring[] nullable

List of SSL protocols

Response

Created

Changes

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