ConfigService


Click here for a complete list of operations.

ReadGroupSettings

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

<?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>
    <ReadGroupSettingsRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <CustomerId>int</CustomerId>
      <DomainId>int</DomainId>
      <GroupId>int</GroupId>
      <GetGroupRecipients>boolean</GetGroupRecipients>
      <GroupRecipientsNumberToRead>int</GroupRecipientsNumberToRead>
      <GroupRecipientsFilter>string</GroupRecipientsFilter>
      <GetAllGroupRecipientData>boolean</GetAllGroupRecipientData>
    </ReadGroupSettingsRequest>
  </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>
    <ReadGroupSettingsResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <OptimisticLockValue>base64Binary</OptimisticLockValue>
      <Settings>
        <UseDomainDefaultDetectionSettings>boolean</UseDomainDefaultDetectionSettings>
        <UseCustomIPAllowedList>boolean</UseCustomIPAllowedList>
        <UseCustomDomainAllowedList>boolean</UseCustomDomainAllowedList>
        <BulkMailAddress>string</BulkMailAddress>
        <SubjectTag>string</SubjectTag>
        <SubjectTagPosition>Uknown or Prepend or Append</SubjectTagPosition>
        <OrdbBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</OrdbBlockedListAction>
        <RblBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</RblBlockedListAction>
        <RssBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</RssBlockedListAction>
        <DulBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</DulBlockedListAction>
        <SigBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</SigBlockedListAction>
        <CustomIPBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</CustomIPBlockedListAction>
        <CustomDomainBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</CustomDomainBlockedListAction>
        <HeuristicsBlockedListAction>Unknown or NoAction or Append or Redirect or Block or TagSubject or Quarantine</HeuristicsBlockedListAction>
      </Settings>
      <HasCustomLists>boolean</HasCustomLists>
      <HasQuarantine>boolean</HasQuarantine>
      <GroupRecipients>
        <Recipient>
          <RecipientId>int</RecipientId>
          <EmailAddress>string</EmailAddress>
          <HasCustomLists>boolean</HasCustomLists>
        </Recipient>
        <Recipient>
          <RecipientId>int</RecipientId>
          <EmailAddress>string</EmailAddress>
          <HasCustomLists>boolean</HasCustomLists>
        </Recipient>
      </GroupRecipients>
      <GroupRecipientsRead>int</GroupRecipientsRead>
      <GroupRecipientsCount>int</GroupRecipientsCount>
    </ReadGroupSettingsResponse>
  </soap:Body>
</soap:Envelope>