GET api/Mail/Config?user={user}&domain={domain}&domHandle={domHandle}

Return a mail config for a domain. Either the name or the handle must be supplied. If both are supplied the handle will be used.

Request Information

URI Parameters

Name	Description	Type	Additional information
user	user handle	string	None.
domain	domain name of the mail config	string	None.
domHandle	domain handle of the mail config	string	None.

Body Parameters

None.

Response Information

Resource Description

a mail config object on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error

MailConfig

Name	Description	Type	Additional information
dom_handle	Object handle of the domain	string	None.
domain	Domain name	string	None.
max_alias	Maximum aliases allowed	integer	None.
max_redir	Maximum redirections allowed - obsolete	integer	None.
max_size	Maximum size	integer	None.
max_mail	Maximum mail boxes allowed	integer	None.
srvGroup	Server group id	integer	None.
available_mail	No of mailboxes available	integer	None.
used_mail	No of mailboxes in use	integer	None.
available_alias	No of aliases available	integer	None.
used_alias	No of aliases in use	integer	None.
is_active	Is active	boolean	None.
config_date_cre	Date created	date	None.
services	Mail services that make up this config	Collection of Service	None.
Errors	List of errors encountered	Collection of Error	None.

Response Formats

application/json, text/json

Sample:

{
  "dom_handle": "sample string 1",
  "domain": "sample string 2",
  "max_alias": 3,
  "max_redir": 4,
  "max_size": 5,
  "max_mail": 6,
  "srvGroup": 7,
  "available_mail": 8,
  "used_mail": 9,
  "available_alias": 10,
  "used_alias": 11,
  "is_active": true,
  "config_date_cre": "2025-12-12T19:18:47.1015953+01:00",
  "services": [
    {
      "handle": "sample string 1",
      "domain_handle": "sample string 2",
      "name": "sample string 3",
      "parent_handle": "sample string 4",
      "parent_type": "sample string 5",
      "max_mail": 6,
      "available_mail": 7,
      "used_mail": 8,
      "expires_at": "2025-12-12T19:18:47.1015953+01:00",
      "AutoRenew": true
    },
    {
      "handle": "sample string 1",
      "domain_handle": "sample string 2",
      "name": "sample string 3",
      "parent_handle": "sample string 4",
      "parent_type": "sample string 5",
      "max_mail": 6,
      "available_mail": 7,
      "used_mail": 8,
      "expires_at": "2025-12-12T19:18:47.1015953+01:00",
      "AutoRenew": true
    }
  ],
  "Errors": []
}

application/xml, text/xml

Sample:

<MailConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Errors />
  <available_alias>10</available_alias>
  <available_mail>8</available_mail>
  <config_date_cre>2025-12-12T19:18:47.1015953+01:00</config_date_cre>
  <dom_handle>sample string 1</dom_handle>
  <domain>sample string 2</domain>
  <is_active>true</is_active>
  <max_alias>3</max_alias>
  <max_mail>6</max_mail>
  <max_redir>4</max_redir>
  <max_size>5</max_size>
  <services>
    <Service>
      <AutoRenew>true</AutoRenew>
      <available_mail>7</available_mail>
      <domain_handle>sample string 2</domain_handle>
      <expires_at>2025-12-12T19:18:47.1015953+01:00</expires_at>
      <handle>sample string 1</handle>
      <max_mail>6</max_mail>
      <name>sample string 3</name>
      <parent_handle>sample string 4</parent_handle>
      <parent_type>sample string 5</parent_type>
      <used_mail>8</used_mail>
    </Service>
    <Service>
      <AutoRenew>true</AutoRenew>
      <available_mail>7</available_mail>
      <domain_handle>sample string 2</domain_handle>
      <expires_at>2025-12-12T19:18:47.1015953+01:00</expires_at>
      <handle>sample string 1</handle>
      <max_mail>6</max_mail>
      <name>sample string 3</name>
      <parent_handle>sample string 4</parent_handle>
      <parent_type>sample string 5</parent_type>
      <used_mail>8</used_mail>
    </Service>
  </services>
  <srvGroup>7</srvGroup>
  <used_alias>11</used_alias>
  <used_mail>9</used_mail>
</MailConfig>