POST api/Mail?user={user}

Request Information

URI Parameters

Name	Description	Type	Additional information
user		string	None.

Body Parameters

MailBoxNew

Name	Type	Additional information
ServiceHandle	string	Required
UserType	string	Required
UserMailAddress	string	Required
UserName	string	Required
UserPwd	string	None.
UserDescription	string	None.
IsCatchAll	boolean	None.
IsRedir	boolean	None.
Forward	Collection of string	None.
Alias	Collection of string	None.
Errors	Collection of Error	None.

Request Formats

application/json, text/json

Sample:

{
  "ServiceHandle": "sample string 1",
  "UserType": "sample string 2",
  "UserMailAddress": "sample string 3",
  "UserName": "sample string 4",
  "UserPwd": "sample string 6",
  "UserDescription": "sample string 7",
  "IsCatchAll": true,
  "IsRedir": true,
  "Forward": [
    "sample string 1",
    "sample string 2"
  ],
  "Alias": [
    "sample string 1",
    "sample string 2"
  ],
  "Errors": []
}

application/xml, text/xml

Sample:

<MailBoxNew 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">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Alias>
  <Errors />
  <Forward xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Forward>
  <IsCatchAll>true</IsCatchAll>
  <IsRedir>true</IsRedir>
  <ServiceHandle>sample string 1</ServiceHandle>
  <UserDescription>sample string 7</UserDescription>
  <UserMailAddress>sample string 3</UserMailAddress>
  <UserName>sample string 4</UserName>
  <UserPwd>sample string 6</UserPwd>
  <UserType>sample string 2</UserType>
</MailBoxNew>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MailBoxNew'.

Response Information

Resource Description

MailBox

Name	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>