Email

Import an existing mailbox over IMAP (mailcow syncjob). The source password goes straight to mailcow and is never stored

post/email/mailboxes/{mailboxId}/sync-jobs

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/email/mailboxes/{mailboxId}/sync-jobs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

mailboxIdstring uuid required

Request body

mailboxIdstring uuid required
hoststring required

source IMAP host

portinteger
encryption'ssl' | 'tls' | 'plain'
usernamestring required
passwordstring required

sent straight to the mail server; not stored by us

deleteFromSourceboolean

delete messages on the source after they are copied

Response

Started

idstring uuid required
mailboxIdstring uuid required
hoststring required
portinteger required
encryption'ssl' | 'tls' | 'plain' required
usernamestring required
mailcowSyncJobIdinteger nullable required
status'pending' | 'running' | 'done' | 'error' required
lastMessagestring nullable required
deleteFromSourceboolean required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

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