migration_status
The migration_status method provides detailed information about the
progress and results of a migration job.
Syntax
{
<credentials object>
"job": <job id>
}
Request fields for migration_status
The following fields can be used in the migration_status method:
Field name | Obligation | Definition/Value |
---|---|---|
job | Required | The ID of the job you are querying. The ID is returned in the migration_add response. |
Response fields for migration_status
The following fields may be returned when the migration_status method is submitted:
Field name | Obligation | Description/Value |
---|---|---|
error | Returned if success = false | A text string that explains the error. |
error_number | Returned if success = false | A number that represents the error. |
rate | Returned if success = true | The aggregate throughput rate for the entire migration job (for all users). |
success | Always returned | Indicates whether the requested change was successful or not. Allowed values are true and false. |
users | Returned if success = true | Information about the migration job. Allowed values are:
|
Examples for migration_status
Request
{
"credentials": {
"user": "[email protected]",
"password": "sw0rdf1sh"
},
"job":"1326229437638"
}
Response
{
"rate": "613.499 KiB/s",
"success": true,
"users": [
{
"data": {
"folders": {
"INBOX": {
"next_uid": "5",
"bytes": 123133,
"migrate_count": 5,
"fail_count": 0,
"retry1count": 0,
"skip_count": 0,
"remote_count": "5",
"retry2count": 0,
"delim": "."
},
"Trash": {
"next_uid": "1",
"skip_count": "1",
"delim": ".",
"remote_count": "1"
},
"Drafts": {
"next_uid": "0",
"delim": ".",
"remote_count": "0"
},
"Spam": {
"next_uid": "1",
"skip_count": "1",
"delim": ".",
"remote_count": "1"
},
"Sent Items": {
"next_uid": "0",
"delim": ".",
"remote_count": "0"
}
},
"status": {
"bytes": 123133,
"fail_count": 0,
"migrate_count": 5,
"skip_count": 2,
"critical_errors": "0",
"foldercount": 5,
"remote_count": "7"
},
"config": {
"server": "mail.bigmail.com:993",
"method": "imap4s",
"remote": "[email protected]"
}
},
"local": "[email protected]",
"state": "complete"
}
]
}
Updated 1 day ago