chibenwa commented on code in PR #3041: URL: https://github.com/apache/james-project/pull/3041#discussion_r3264294523
########## docs/modules/servers/partials/operate/webadmin.adoc: ########## @@ -1759,6 +1759,33 @@ and the following `additionalInformation`: } .... +=== Restoring user mailboxes + +.... +curl -XPOST http://ip:port/users/{usernameToBeUsed}/mailboxes?task=restore --data-binary @backup.zip +.... + +Resource name `usernameToBeUsed` should be an existing user. The request body must contain the ZIP backup data. + +Response codes: + +* 201: Success. Corresponding task id is returned +* 400: The request body is empty +* 404: The user name does not exist + +The scheduled task will have the following type `MailboxesRestoreTask` +and the following `additionalInformation`: + +.... +{ + "type":"MailboxesRestoreTask", + "timestamp":"2007-12-03T10:15:30Z", + "username": "user" +} +.... + +Note: The account must be empty for the restore to succeed. If the user already has mailboxes, the task will fail. + Review Comment: Please document `?force` parameter -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
