svcDomainAdmin


Click here for a complete list of operations.

GetDomainSettings

Returns the settings for a specific domain.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/svcDomainAdmin.asmx HTTP/1.1
Host: dgxdatacenter-001-site2.mysitepanel.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetDomainSettings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDomainSettings xmlns="http://tempuri.org/">
      <AuthUserName>string</AuthUserName>
      <AuthPassword>string</AuthPassword>
      <domainName>string</domainName>
    </GetDomainSettings>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDomainSettingsResponse xmlns="http://tempuri.org/">
      <GetDomainSettingsResult>
        <Result>boolean</Result>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <ServerIP>string</ServerIP>
        <Path>string</Path>
        <ImapPort>int</ImapPort>
        <PopPort>int</PopPort>
        <SmtpPort>int</SmtpPort>
        <MaxAliases>int</MaxAliases>
        <MaxDomainAliases>int</MaxDomainAliases>
        <MaxLists>int</MaxLists>
        <MaxDomainSizeInMB>long</MaxDomainSizeInMB>
        <MaxDomainUsers>int</MaxDomainUsers>
        <MaxMailboxSizeInMB>int</MaxMailboxSizeInMB>
        <MaxMessageSize>int</MaxMessageSize>
        <MaxRecipients>int</MaxRecipients>
        <ShowDomainAliasMenu>boolean</ShowDomainAliasMenu>
        <ShowContentFilteringMenu>boolean</ShowContentFilteringMenu>
        <ShowSpamMenu>boolean</ShowSpamMenu>
        <ShowStatsMenu>boolean</ShowStatsMenu>
        <ShowListMenu>boolean</ShowListMenu>
        <RequireSmtpAuthentication>boolean</RequireSmtpAuthentication>
        <ListCommandAddress>string</ListCommandAddress>
      </GetDomainSettingsResult>
    </GetDomainSettingsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/svcDomainAdmin.asmx HTTP/1.1
Host: dgxdatacenter-001-site2.mysitepanel.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDomainSettings xmlns="http://tempuri.org/">
      <AuthUserName>string</AuthUserName>
      <AuthPassword>string</AuthPassword>
      <domainName>string</domainName>
    </GetDomainSettings>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDomainSettingsResponse xmlns="http://tempuri.org/">
      <GetDomainSettingsResult>
        <Result>boolean</Result>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <ServerIP>string</ServerIP>
        <Path>string</Path>
        <ImapPort>int</ImapPort>
        <PopPort>int</PopPort>
        <SmtpPort>int</SmtpPort>
        <MaxAliases>int</MaxAliases>
        <MaxDomainAliases>int</MaxDomainAliases>
        <MaxLists>int</MaxLists>
        <MaxDomainSizeInMB>long</MaxDomainSizeInMB>
        <MaxDomainUsers>int</MaxDomainUsers>
        <MaxMailboxSizeInMB>int</MaxMailboxSizeInMB>
        <MaxMessageSize>int</MaxMessageSize>
        <MaxRecipients>int</MaxRecipients>
        <ShowDomainAliasMenu>boolean</ShowDomainAliasMenu>
        <ShowContentFilteringMenu>boolean</ShowContentFilteringMenu>
        <ShowSpamMenu>boolean</ShowSpamMenu>
        <ShowStatsMenu>boolean</ShowStatsMenu>
        <ShowListMenu>boolean</ShowListMenu>
        <RequireSmtpAuthentication>boolean</RequireSmtpAuthentication>
        <ListCommandAddress>string</ListCommandAddress>
      </GetDomainSettingsResult>
    </GetDomainSettingsResponse>
  </soap12:Body>
</soap12:Envelope>