ConfigService


Click here for a complete list of operations.

ReadMESubscriber

Please see latest endpoint documentation for more details

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 /customerapi-1-22/configservice/service.asmx HTTP/1.1
Host: api.messagelabs.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.messagelabs.com/2005/01/Customer/ReadMESubscriber"

<?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>
    <ReadMESubscriberRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <CustomerId>int</CustomerId>
      <LoadUnNominatedDomains>boolean</LoadUnNominatedDomains>
      <LoadMailServers>boolean</LoadMailServers>
      <LoadAlerts>boolean</LoadAlerts>
      <LoadNominatedDomains>boolean</LoadNominatedDomains>
      <LoadPartners>boolean</LoadPartners>
      <NominatedDomainFilter>string</NominatedDomainFilter>
    </ReadMESubscriberRequest>
  </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>
    <From.ReadMESubscriberResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <MESubscriber>
        <CustomerId>int</CustomerId>
        <OptimisticLockValue>base64Binary</OptimisticLockValue>
        <IsDeleted>boolean</IsDeleted>
        <NominatedDomains>
          <MENominatedDomain>
            <IsDomainExcluded>boolean</IsDomainExcluded>
            <UseDefaultMailServers>boolean</UseDefaultMailServers>
          </MENominatedDomain>
          <MENominatedDomain>
            <IsDomainExcluded>boolean</IsDomainExcluded>
            <UseDefaultMailServers>boolean</UseDefaultMailServers>
          </MENominatedDomain>
        </NominatedDomains>
        <CertificateExpireAlerts>
          <MECertificateExpiryAlert>
            <NotificationPeriodDays>int</NotificationPeriodDays>
          </MECertificateExpiryAlert>
          <MECertificateExpiryAlert>
            <NotificationPeriodDays>int</NotificationPeriodDays>
          </MECertificateExpiryAlert>
        </CertificateExpireAlerts>
        <Partners>
          <MEPartner>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <IsDeleted>boolean</IsDeleted>
            <UseDefaultProtectionStrength>boolean</UseDefaultProtectionStrength>
            <MinProtectionStrength>Normal or Export</MinProtectionStrength>
            <UseDefaultInboundAuthentication>boolean</UseDefaultInboundAuthentication>
            <InboundAuthentication>boolean</InboundAuthentication>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <Comments>string</Comments>
            <PartnerDomains xsi:nil="true" />
            <CustomerId>int</CustomerId>
            <Id>int</Id>
            <PartnerName>string</PartnerName>
          </MEPartner>
          <MEPartner>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <IsDeleted>boolean</IsDeleted>
            <UseDefaultProtectionStrength>boolean</UseDefaultProtectionStrength>
            <MinProtectionStrength>Normal or Export</MinProtectionStrength>
            <UseDefaultInboundAuthentication>boolean</UseDefaultInboundAuthentication>
            <InboundAuthentication>boolean</InboundAuthentication>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <Comments>string</Comments>
            <PartnerDomains xsi:nil="true" />
            <CustomerId>int</CustomerId>
            <Id>int</Id>
            <PartnerName>string</PartnerName>
          </MEPartner>
        </Partners>
        <DefaultMailSevers>
          <MEMailServer>
            <MailServerId>int</MailServerId>
            <MXHost>string</MXHost>
            <CustomerId>int</CustomerId>
            <MEDomainId>int</MEDomainId>
            <HostName>string</HostName>
            <IPAddress>string</IPAddress>
            <CAName>string</CAName>
            <CryptoStrength>int</CryptoStrength>
            <DateTested>dateTime</DateTested>
            <TestPassed>boolean</TestPassed>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <RoutingType>Unknown or DNS or StaticRoutes or SmtpRoutes</RoutingType>
            <LastTestDialogue>string</LastTestDialogue>
            <LastTestResult>string</LastTestResult>
          </MEMailServer>
          <MEMailServer>
            <MailServerId>int</MailServerId>
            <MXHost>string</MXHost>
            <CustomerId>int</CustomerId>
            <MEDomainId>int</MEDomainId>
            <HostName>string</HostName>
            <IPAddress>string</IPAddress>
            <CAName>string</CAName>
            <CryptoStrength>int</CryptoStrength>
            <DateTested>dateTime</DateTested>
            <TestPassed>boolean</TestPassed>
            <OptimisticLockValue>base64Binary</OptimisticLockValue>
            <RoutingType>Unknown or DNS or StaticRoutes or SmtpRoutes</RoutingType>
            <LastTestDialogue>string</LastTestDialogue>
            <LastTestResult>string</LastTestResult>
          </MEMailServer>
        </DefaultMailSevers>
        <UseDefaultInvitationText>boolean</UseDefaultInvitationText>
        <InvitationText>string</InvitationText>
        <AdminEmailAddress>string</AdminEmailAddress>
        <UseDefaultProtectionStrength>boolean</UseDefaultProtectionStrength>
        <MinProtectionStrength>Normal or Export</MinProtectionStrength>
        <UseDefaultInboundAuthentication>boolean</UseDefaultInboundAuthentication>
        <InboundAuthentication>boolean</InboundAuthentication>
      </MESubscriber>
      <UnNomindatedDomains>
        <Domain>
          <Id>int</Id>
          <Name>string</Name>
          <Services>None or Unknown or Branding or Content or Image or Mail or Sms or Spam or Virus or ManagedEncryption or WebScanning or RegisteredUser or Archiving or WebVirus or WebSpyware or WebUrlFiltering or LDAPUserGroups or NamedRoutes or Quarantine or ConfigurationNotification or IMSecurityService or All</Services>
        </Domain>
        <Domain>
          <Id>int</Id>
          <Name>string</Name>
          <Services>None or Unknown or Branding or Content or Image or Mail or Sms or Spam or Virus or ManagedEncryption or WebScanning or RegisteredUser or Archiving or WebVirus or WebSpyware or WebUrlFiltering or LDAPUserGroups or NamedRoutes or Quarantine or ConfigurationNotification or IMSecurityService or All</Services>
        </Domain>
      </UnNomindatedDomains>
    </From.ReadMESubscriberResponse>
  </soap:Body>
</soap:Envelope>