DELETE Exchange Mailbox - Revision history

Mike.robski: 1 revision: Release 103

2015-02-06T17:24:36Z

1 revision: Release 103

Jerry.dimitrov: /* URI Parameters */

2014-08-27T11:24:28Z

URI Parameters

Mike.robski: 1 revision: Release 95

2014-07-02T05:59:33Z

1 revision: Release 95

Petre.popescu at 11:34, 21 May 2014

2014-05-21T11:34:56Z

New page

= DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{useName}'' =
Deletes an Exchange mailbox. The deletion process is asynchronous.

__TOC__

== Request ==
<code>DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{userName}''</code>

==== Request Parameters ====
; accountNumber - ''string''
: the account number of the mailbox owner

; domaiName - ''string''
: the domain name of the mailbox

; userName - ''string''
: the username of the mailbox

=== Request Headers ===
{{Authorization}}

=== Request Body ===
None

== Response ==

=== Status Code ===
; 202 - ''Accepted''
: the deletion request has been accepted.

; 401 - ''Unauthorized''
: the Authorization credentials are wrong or missing.

; 403 - ''Forbidden''
: the user has been authorized. However, they are not allowed to access the resource. The only user(s) who has access to an Exchange mailbox must be a sales agent or the account owner, or the account technical admin.

; 404 - ''Not Found''
: the mailbox does not exist.

; 409 - ''Conflict''
: the deletion request was rejected due to conflict. Mailboxes with '''pending''', '''close_pending''', '''purge_pending''' status cannot be deleted.

== Examples ==

=== Delete an existent '''open''' or '''closed''' mailbox ===
'''Request'''
<nowiki>
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
</nowiki>

'''Response'''
<nowiki>
202 Accepted

no-body
</nowiki>

=== Delete an existent '''pending''' mailbox ===
'''Request'''
<nowiki>
DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
</nowiki>

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

{
"conflict" : {
"guid" : "<generated_value>",
"message" : "Cannot delete pending mailboxes",
"code" : 409,
"details" : ""
}
}
</nowiki>

== See also ==

* [[Exchange#Mailbox_Operations|Exchange Mailbox Operations]]
* [[Common Features]]

[[Category:Hostway API]]
[[Category:Exchange API]]

@@ Line 5: / Line 5: @@
 == Request ==
-<code>DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{userName}''</code>
+<code>DELETE /accounts/''{accountNumber}''/exchange/''{domainName}''/mailboxes/''{userName}''?purge=''purge-flag''</code>
 ==== Request Parameters ====
@@ Line 16: / Line 16: @@
 ; userName - ''string''
 : the username of the mailbox
 === Request Headers ===
@@ Line 33: / Line 38: @@
 ; 403 - ''Forbidden''
-: the user has been authorized. However, they are not allowed to access the resource. The only user(s) who has access to an Exchange mailbox must be a sales agent or the account owner, or the account technical admin.
+: the user has been authorized. However, they are not allowed to access the resource. The only user(s) who has access to an Exchange mailbox must be a sales agent or the account owner, or the account technical admin. Additionally, this status may be raised when attempting to delete the mailbox with purge=0 without sales agent credentials.
 ; 404 - ''Not Found''
@@ Line 47: / Line 52: @@
 '''Request'''
   <nowiki>
-DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>
+DELETE http://<server_name>/accounts/<account_number>/exchange/<domain-name>/mailboxes/<existent-mailbox-username>?purge=1
   </nowiki>