TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/mailserver/server This function requires authentication

Description

Returns the mail server associated with the current tenant.

Parameters

This method doesn't have any parameters.

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

Mail server data for the current tenant

Example Response

application/json

{
  "status": 0,
  "response": {
    "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
    }
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>
  </response>
</result>