Create auto migration for user

Create new MailUser by checking their credentials with source IMAP server and migrate their emails

  • HTTP Method: POST
  • URL: https://example.domain.tld/api/v1/automigration/users/
  • Require authentication: No

Request parameters

Parameter Type Description Required
username str Email address of MailUser Required
old_password str Password for account on source (old) IMAP server Required
new_password str Password for account on destination (NMS) server Required
recovery_email str Email to use for password reset Required
language str ISO 639-1 or ISO 639-2 language code Required
storagequota_total int Storage quota in MB Required

Response parameters

Parameter Type Description
username str MailUser created for automatic migration

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/automigration/users/"
data = {
"username" : "",
"old_password" : "NCg55iljdQe6qR6a8bIh",
"new_password" : "njtbElGtDAgWCicUuo8F",
"recovery_email" : "recovery@domain.tld",
"language" : "en",
"storagequota_total" : 100
r =, json=data)

Example response (JSON)

{'username': ''}