Get Started
Usage API
More information

GET api/2.0/mailserver/serverinfo/get This function requires authentication

Description

Returns full information on the mail server associated with the current tenant.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/mailserver/serverinfo/get
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Full mail server information for the current tenant

Example Response

application/json

{
  "status": 0,
  "response": {
    "Server": {
      "Id": 1234,
      "Dns": {
        "Id": 1234,
        "MxRecord": {
          "Host": "Host",
          "Priority": 1234,
          "IsVerified": true
        },
        "SpfRecord": {
          "Name": "name",
          "Value": "value",
          "IsVerified": true
        },
        "DkimRecord": {
          "Selector": "Selector",
          "PublicKey": "PublicKey",
          "IsVerified": true
        },
        "DomainCheckRecord": {
          "Name": "name",
          "Value": "value",
          "IsVerified": true
        }
      },
      "ServerLimits": {
        "MailboxMaxCountPerUser": 5
      },
      "InServer": {
        "Id": 1234,
        "ProviderId": 1234,
        "Type": "Type",
        "Hostname": "Hostname",
        "Port": 1234,
        "SocketType": "SocketType",
        "Username": "Username",
        "Authentication": "Authentication",
        "IsUserData": true
      },
      "OutServer": {
        "Id": 1234,
        "ProviderId": 1234,
        "Type": "Type",
        "Hostname": "Hostname",
        "Port": 1234,
        "SocketType": "SocketType",
        "Username": "Username",
        "Authentication": "Authentication",
        "IsUserData": true
      }
    },
    "Domains": [
      {
        "Id": "id",
        "IsSharedDomain": true,
        "Name": "Name",
        "Dns": {
          "Id": 1234,
          "MxRecord": {
            "Host": "Host",
            "Priority": 1234,
            "IsVerified": true
          },
          "SpfRecord": {
            "Name": "name",
            "Value": "value",
            "IsVerified": true
          },
          "DkimRecord": {
            "Selector": "Selector",
            "PublicKey": "PublicKey",
            "IsVerified": true
          },
          "DomainCheckRecord": {
            "Name": "name",
            "Value": "value",
            "IsVerified": true
          }
        }
      }
    ],
    "Mailboxes": [
      {
        "Id": 1234,
        "UserId": "UserId",
        "UserDisplayName": "UserDisplayName",
        "Address": {
          "Id": 1234,
          "DomainId": 1234,
          "Email": "Email@only.com"
        },
        "Name": "Name",
        "Aliases": [
          {
            "Id": 1234,
            "DomainId": 1234,
            "Email": "Email@only.com"
          }
        ]
      }
    ],
    "Mailgroups": [
      {
        "Id": 1234,
        "Address": {
          "Id": 1234,
          "DomainId": 1234,
          "Email": "Email@only.com"
        },
        "Addresses": [
          {
            "Id": 1234,
            "DomainId": 1234,
            "Email": "Email@only.com"
          }
        ]
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Server>
      <Id>1234</Id>
      <Dns>
        <Id>1234</Id>
        <MxRecord>
          <Host>Host</Host>
          <Priority>1234</Priority>
          <IsVerified>True</IsVerified>
        </MxRecord>
        <SpfRecord>
          <Name>name</Name>
          <Value>value</Value>
          <IsVerified>True</IsVerified>
        </SpfRecord>
        <DkimRecord>
          <Selector>Selector</Selector>
          <PublicKey>PublicKey</PublicKey>
          <IsVerified>True</IsVerified>
        </DkimRecord>
        <DomainCheckRecord>
          <Name>name</Name>
          <Value>value</Value>
          <IsVerified>True</IsVerified>
        </DomainCheckRecord>
      </Dns>
      <ServerLimits>
        <MailboxMaxCountPerUser>5</MailboxMaxCountPerUser>
      </ServerLimits>
      <InServer>
        <Id>1234</Id>
        <ProviderId>1234</ProviderId>
        <Type>Type</Type>
        <Hostname>Hostname</Hostname>
        <Port>1234</Port>
        <SocketType>SocketType</SocketType>
        <Username>Username</Username>
        <Authentication>Authentication</Authentication>
        <IsUserData>True</IsUserData>
      </InServer>
      <OutServer>
        <Id>1234</Id>
        <ProviderId>1234</ProviderId>
        <Type>Type</Type>
        <Hostname>Hostname</Hostname>
        <Port>1234</Port>
        <SocketType>SocketType</SocketType>
        <Username>Username</Username>
        <Authentication>Authentication</Authentication>
        <IsUserData>True</IsUserData>
      </OutServer>
    </Server>
    <Domains>
      <Id>id</Id>
      <IsSharedDomain>True</IsSharedDomain>
      <Name>Name</Name>
      <Dns>
        <Id>1234</Id>
        <MxRecord>
          <Host>Host</Host>
          <Priority>1234</Priority>
          <IsVerified>True</IsVerified>
        </MxRecord>
        <SpfRecord>
          <Name>name</Name>
          <Value>value</Value>
          <IsVerified>True</IsVerified>
        </SpfRecord>
        <DkimRecord>
          <Selector>Selector</Selector>
          <PublicKey>PublicKey</PublicKey>
          <IsVerified>True</IsVerified>
        </DkimRecord>
        <DomainCheckRecord>
          <Name>name</Name>
          <Value>value</Value>
          <IsVerified>True</IsVerified>
        </DomainCheckRecord>
      </Dns>
    </Domains>
    <Mailboxes>
      <Id>1234</Id>
      <UserId>UserId</UserId>
      <UserDisplayName>UserDisplayName</UserDisplayName>
      <Address>
        <Id>1234</Id>
        <DomainId>1234</DomainId>
        <Email>Email@only.com</Email>
      </Address>
      <Name>Name</Name>
      <Aliases>
        <Id>1234</Id>
        <DomainId>1234</DomainId>
        <Email>Email@only.com</Email>
      </Aliases>
    </Mailboxes>
    <Mailgroups>
      <Id>1234</Id>
      <Address>
        <Id>1234</Id>
        <DomainId>1234</DomainId>
        <Email>Email@only.com</Email>
      </Address>
      <Addresses>
        <Id>1234</Id>
        <DomainId>1234</DomainId>
        <Email>Email@only.com</Email>
      </Addresses>
    </Mailgroups>
  </response>
</result>