DELETE api/Mail/{handle}?user={user}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
handle | string |
Required |
|
user | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MailBoxName | Description | Type | Additional information |
---|---|---|---|
ObjectHandle |
Object handle of the mail box |
string |
None. |
DomHandle |
Object handle of the domain |
string |
None. |
State |
State after execution - completed or pending |
string |
None. |
CreDate |
Create date |
date |
None. |
ServiceHandle | string |
None. |
|
UserType | string |
None. |
|
UserName | string |
None. |
|
UserPwd | string |
None. |
|
UserDescription | string |
None. |
|
UserMailAddress | string |
None. |
|
IsCatchAll | boolean |
None. |
|
IsRedir | boolean |
None. |
|
Forward | Collection of string |
None. |
|
Alias | Collection of string |
None. |
|
Errors | Collection of Error |
None. |
Response Formats
application/json, text/json
Sample:
{ "ObjectHandle": "some2", "DomHandle": "somed1", "State": null, "CreDate": "0001-01-01T00:00:00", "ServiceHandle": "some1", "UserType": "pop", "UserName": "user", "UserPwd": null, "UserDescription": null, "UserMailAddress": "someone@somedomain.com", "IsCatchAll": null, "IsRedir": null, "Forward": null, "Alias": null, "Errors": [] }
application/xml, text/xml
Sample:
<MailBox xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models"> <Alias xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Errors /> <Forward xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <IsCatchAll i:nil="true" /> <IsRedir i:nil="true" /> <ServiceHandle>some1</ServiceHandle> <UserDescription i:nil="true" /> <UserMailAddress>someone@somedomain.com</UserMailAddress> <UserName>user</UserName> <UserPwd i:nil="true" /> <UserType>pop</UserType> <CreDate>0001-01-01T00:00:00</CreDate> <DomHandle>somed1</DomHandle> <State i:nil="true" /> </MailBox>