GET api/Mail?user={user}&address={address}&objectHandle={objectHandle}&serviceHandle={serviceHandle}&domHandle={domHandle}

Returns a list of mailboxes for the specified user with optional filters

Request Information

URI Parameters

Name	Description	Type	Additional information
user	User handle	string	None.
address	Email address	string	None.
objectHandle	Mailbox object handle	string	None.
serviceHandle	Service object handle	string	None.
domHandle	Domain object handle	string	None.

Body Parameters

None.

Response Information

Resource Description

List of mailboxes on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error

Collection of MailBox

Name	Description	Type	Additional information
ServiceHandle	Object handle of the mail service	string	Required
ObjectHandle	Object handle of the mail box	string	None.
DomHandle	Object handle of the domain	string	None.
UserType	User type - pop or alias	string	Required
UserName	User name	string	None.
UserPwd	User password	string	None.
UserDescription	User description	string	None.
UserMailAddress	Email address of mail box	string	Required
IsCatchAll	Catch all flag	boolean	None.
IsRedir	Is a redirection	boolean	None.
Forward	Forward to address(s) for user type alias or when is a redirection	Collection of string	None.
Alias	List of aliases for this address	Collection of string	None.
Etat	Update mode - 1 new, 2 update, 3 delete	integer	None.
State	State after execution - completed or pending	string	None.
CreDate	Create date	date	None.
Errors	List of errors encountered	Collection of Error	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ServiceHandle": "sample string 1",
    "ObjectHandle": "sample string 2",
    "DomHandle": "sample string 3",
    "UserType": "sample string 4",
    "UserName": "sample string 5",
    "UserPwd": "sample string 6",
    "UserDescription": "sample string 7",
    "UserMailAddress": "sample string 8",
    "IsCatchAll": true,
    "IsRedir": true,
    "Forward": [
      "sample string 1",
      "sample string 2"
    ],
    "Alias": [
      "sample string 1",
      "sample string 2"
    ],
    "Etat": 11,
    "State": "sample string 12",
    "CreDate": "2025-04-04T00:33:25.6897024+02:00",
    "Errors": []
  },
  {
    "ServiceHandle": "sample string 1",
    "ObjectHandle": "sample string 2",
    "DomHandle": "sample string 3",
    "UserType": "sample string 4",
    "UserName": "sample string 5",
    "UserPwd": "sample string 6",
    "UserDescription": "sample string 7",
    "UserMailAddress": "sample string 8",
    "IsCatchAll": true,
    "IsRedir": true,
    "Forward": [
      "sample string 1",
      "sample string 2"
    ],
    "Alias": [
      "sample string 1",
      "sample string 2"
    ],
    "Etat": 11,
    "State": "sample string 12",
    "CreDate": "2025-04-04T00:33:25.6897024+02:00",
    "Errors": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailBox xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <MailBox>
    <Alias xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Alias>
    <CreDate>2025-04-04T00:33:25.6897024+02:00</CreDate>
    <DomHandle>sample string 3</DomHandle>
    <Errors />
    <Etat>11</Etat>
    <Forward xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Forward>
    <IsCatchAll>true</IsCatchAll>
    <IsRedir>true</IsRedir>
    <ObjectHandle>sample string 2</ObjectHandle>
    <ServiceHandle>sample string 1</ServiceHandle>
    <State>sample string 12</State>
    <UserDescription>sample string 7</UserDescription>
    <UserMailAddress>sample string 8</UserMailAddress>
    <UserName>sample string 5</UserName>
    <UserPwd>sample string 6</UserPwd>
    <UserType>sample string 4</UserType>
  </MailBox>
  <MailBox>
    <Alias xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Alias>
    <CreDate>2025-04-04T00:33:25.6897024+02:00</CreDate>
    <DomHandle>sample string 3</DomHandle>
    <Errors />
    <Etat>11</Etat>
    <Forward xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Forward>
    <IsCatchAll>true</IsCatchAll>
    <IsRedir>true</IsRedir>
    <ObjectHandle>sample string 2</ObjectHandle>
    <ServiceHandle>sample string 1</ServiceHandle>
    <State>sample string 12</State>
    <UserDescription>sample string 7</UserDescription>
    <UserMailAddress>sample string 8</UserMailAddress>
    <UserName>sample string 5</UserName>
    <UserPwd>sample string 6</UserPwd>
    <UserType>sample string 4</UserType>
  </MailBox>
</ArrayOfMailBox>