Skip to main content
POST
Add a seed inbox

Authorizations

X-API-Key
string
header
required

Body

application/json
kind
string
required

imap or mailbox.

email
string

Seed address (kind=imap).

imap_host
string

IMAP host (kind=imap).

imap_password
string

IMAP password or app password (kind=imap).

imap_port
integer

Default 993.

imap_security
string

ssl (default), starttls or none.

imap_username
string

Default: the email.

mailbox_id
integer

Connected mailbox to use (kind=mailbox).

provider
string

Label such as Gmail, Outlook, Yahoo.

Response

200

JSON {ok, messages}.