Email-domain-usernames-mailboxName-mailbox-action:POST - Revision history

Mike.robski: 1 revision: Release 101

2014-12-17T04:50:55Z

1 revision: Release 101

Jerry.dimitrov: Replaced content with "{{resetPassword|| a|resource=mailbox|base=|base_example=}}"

2014-12-04T14:14:47Z

Replaced content with "{{resetPassword|| a|resource=mailbox|base=|base_example=}}"

Mike.robski: 1 revision: Release 98

2014-09-15T13:53:43Z

1 revision: Release 98

Jerry.dimitrov: /* Request Parameters */

2014-09-05T14:58:50Z

Request Parameters

New page

= POST /email/{domain}/usernames/{mailboxName}/mailbox/action =
Apply an action on a mailbox e.g. '''reset password'''

__TOC__

== Request ==
<code>POST /email/{domain}/usernames/{mailboxName}/mailbox/action</code>

==== Request Parameters ====
; domain - ''string''
: The specific domain for which the call will retrieve the list
; maiboxName - ''string''
: The name of the mailbox.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"action": "resetPassword",
"actionData": {
"secretQuestion": "{tk}",
"secretAnswer": "{answer}",
"password": "{password}"
}
}
</nowiki>

; action - ''string''
: The action that should be performed. Allowed values are:
:: '''resetPassword''' - Reset the password of a mailbox.

; actionData - ''string (Required)''
: Data to be send with the action.

; tk - ''string'' (Required)
: The text key for the secret question. There should be no duplicate text keys per mailbox.

; answer - ''string'' (Required)
: The answer in plain-text - must be at least two characters.
{{:Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT}}

== Response ==

=== Expected Response Codes ===
; 204 No Content
: Success

; 400 Bad Request
: The supplied action or the supplied data is invalid.

; 404 Not Found
: The resource does not exist.

; 409 Conflict
: Validation of the secret answer failed.

== Examples ==

=== Request password reset of a mailbox ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/mailbox123/mailbox/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestion": "tk1",
"secretAnswer": "answer123",
"password": "pWord123$"
}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Request password reset of a mailbox with wrong answer ===
'''Request'''
<nowiki>
POST /email/test.com/usernames/mailbox123/mailbox/action
Content-Type: application/json; Charset=UTF-8

{
"action": "resetPassword",
"actionData": {
"secretQuestion": "tk1",
"secretAnswer": "wrongAnswer",
"password": "pWord123$"
}
</nowiki>

'''Response'''
<nowiki>
409 Conflict

{
"conflict": {
"message": "Verification failed",
"code": 409,
}
}
</nowiki>
== See also ==
* [[Email API|Email API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 1: / Line 1: @@
-= POST /email/{domain}/usernames/{mailboxName}/mailbox/action =
+{{resetPassword|| a|resource=mailbox|base=|base_example=}}
-Apply an action on a mailbox e.g. '''reset password'''
-−
-__TOC__
-−
-== Request ==
-<code>POST /email/{domain}/usernames/{mailboxName}/mailbox/action</code>
-−
-==== Request Parameters ====
-; domain - ''string''
-: The specific domain for which the call will retrieve the list
-; maiboxName - ''string''
-: The name of the mailbox.
-−
-=== Request Headers ===
-; Content-Type
-: Required. Set this header to <code>application/json; charset=UTF-8</code>
-−
-=== Request Body ===
- <nowiki>
-−
-  "action": "resetPassword",
-  "actionData": {
-    "secretQuestion": "{tk}",
-    "secretAnswer": "{answer}",
-    "password": "{password}"
-−
-−
- </nowiki>
-−
-; action - ''string''
-: The action that should be performed. Allowed values are:
-:: '''resetPassword''' - Reset the password of a mailbox.
-−
-; actionData - ''string (Required)''
-: Data to be send with the action.
-−
-; tk - ''string'' (Required)
-: The text key for the secret question. There should be no duplicate text keys per mailbox.
-−
-; answer - ''string'' (Required)
-: The answer in plain-text - must be at least two characters.
-{{:Accounts-account-email-domain-usernames-mailboxName-mailbox:PUT}}
-−
-== Response ==
-−
-=== Expected Response Codes  ===
-; 204 No Content
-: Success
-−
-; 400 Bad Request
-: The supplied action or the supplied data is invalid.
-−
-; 404 Not Found
-: The resource does not exist.
-−
-; 409 Conflict
-: Validation of the secret answer failed.
-−
-== Examples ==
-−
-=== Request password reset of a mailbox ===
-'''Request'''
- <nowiki>
-POST /email/test.com/usernames/mailbox123/mailbox/action
-Content-Type: application/json; Charset=UTF-8
-−
-−
-  "action": "resetPassword",
-  "actionData": {
-    "secretQuestion": "tk1",
-    "secretAnswer": "answer123",
-    "password": "pWord123$"
-−
- </nowiki>
-−
-'''Response'''
- <nowiki>
-No Content
- </nowiki>
-−
-=== Request password reset of a mailbox with wrong answer ===
-'''Request'''
- <nowiki>
-POST /email/test.com/usernames/mailbox123/mailbox/action
-Content-Type: application/json; Charset=UTF-8
-−
-−
-  "action": "resetPassword",
-  "actionData": {
-    "secretQuestion": "tk1",
-    "secretAnswer": "wrongAnswer",
-    "password": "pWord123$"
-−
- </nowiki>
-−
-'''Response'''
- <nowiki>
-Conflict
-−
-−
-  "conflict": {
-    "message": "Verification failed",
-    "code": 409,
-−
-−
- </nowiki>
-== See also ==
-* [[Email API|Email API]]
-−
-{{disqus}}
-[[Category:Hostway API]]
-[[Category:Email API]]