ConfigService


Click here for a complete list of operations.

ReadCustomLists

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/ReadCustomLists"

<?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>
    <ReadCustomListsRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <CustomerId>int</CustomerId>
      <DomainId>int</DomainId>
      <GroupId>int</GroupId>
      <RecipientEmailAddress>string</RecipientEmailAddress>
      <ListType>Unknown or Recipient or Group or DomainDefault</ListType>
      <GetAllowedList>boolean</GetAllowedList>
      <AllowedListStartDate>dateTime</AllowedListStartDate>
      <AllowedListEndDate>dateTime</AllowedListEndDate>
      <AllowedListNumberToRead>int</AllowedListNumberToRead>
      <AllowedListFilter>string</AllowedListFilter>
      <GetBlockedList>boolean</GetBlockedList>
      <BlockedListStartDate>dateTime</BlockedListStartDate>
      <BlockedListEndDate>dateTime</BlockedListEndDate>
      <BlockedListNumberToRead>int</BlockedListNumberToRead>
      <BlockedListFilter>string</BlockedListFilter>
    </ReadCustomListsRequest>
  </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>
    <ReadCustomListsResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <OptimisticLockValue>base64Binary</OptimisticLockValue>
      <AllowedListItems>
        <SpamCustomListItem>
          <Id>guid</Id>
          <Value>string</Value>
          <Description>string</Description>
          <Type>Unknown or Email or Domain or IP</Type>
          <DateCreated>dateTime</DateCreated>
          <IsDeleted>boolean</IsDeleted>
        </SpamCustomListItem>
        <SpamCustomListItem>
          <Id>guid</Id>
          <Value>string</Value>
          <Description>string</Description>
          <Type>Unknown or Email or Domain or IP</Type>
          <DateCreated>dateTime</DateCreated>
          <IsDeleted>boolean</IsDeleted>
        </SpamCustomListItem>
      </AllowedListItems>
      <AllowedListItemsRead>int</AllowedListItemsRead>
      <AllowedListItemsCount>int</AllowedListItemsCount>
      <BlockedListItems>
        <SpamCustomListItem>
          <Id>guid</Id>
          <Value>string</Value>
          <Description>string</Description>
          <Type>Unknown or Email or Domain or IP</Type>
          <DateCreated>dateTime</DateCreated>
          <IsDeleted>boolean</IsDeleted>
        </SpamCustomListItem>
        <SpamCustomListItem>
          <Id>guid</Id>
          <Value>string</Value>
          <Description>string</Description>
          <Type>Unknown or Email or Domain or IP</Type>
          <DateCreated>dateTime</DateCreated>
          <IsDeleted>boolean</IsDeleted>
        </SpamCustomListItem>
      </BlockedListItems>
      <BlockedListItemsRead>int</BlockedListItemsRead>
      <BlockedListItemsCount>int</BlockedListItemsCount>
    </ReadCustomListsResponse>
  </soap:Body>
</soap:Envelope>