Partners

Test source mailboxes for a migration

Log into every source mailbox on your own IMAP server (five at a time, at most 100 rows per call) and report per row: whether the login worked, how much mail is there, whether the Faivelo mailbox already exists, and whether the lot fits the customer's storage. Nothing is created and no password is returned. 10 calls per 10 minutes per partner. Requires partner:write.

post/customers/{id}/domains/{domain}/migrations/test

Request

Base URL: https://faivelo.com/api/partner
URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/migrations/test
Auth: HTTP bearer

Path parameters

idstring required

Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

Request body

csvstring

email,password[,newPassword], one mailbox per line; an optional header line; cells may be double-quoted

expectedBytesobject

Bytes per source address from the test, so create can refuse what does not fit before creating anything

Example request

{
  "source": {
    "host": "mail.yourserver.com"
  },
  "csv": "email,password\nana@smiledental.example,her-current-password"
}

Response

Per-row results and the storage fit

successboolean

Example response

{
  "success": true
}

Changes

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