ConfigService Web Service

ConfigService

Click here for a complete list of operations.

ReadContentService

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

<?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>
    <ReadContentServiceRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <CustomerId>int</CustomerId>
      <DomainId>int</DomainId>
      <RuleFilterType>None or All or ActiveOnly or InactiveOnly</RuleFilterType>
      <ListsFilterType>None or AllAvailable or Editable</ListsFilterType>
      <ListNameFilter>string</ListNameFilter>
      <GroupsFilterType>None or AllAvailable or Editable</GroupsFilterType>
      <GroupNameFilter>string</GroupNameFilter>
      <GetUsers>boolean</GetUsers>
      <UserNameFilter>string</UserNameFilter>
      <MaxUsersToReturn>int</MaxUsersToReturn>
      <GetTimezones>boolean</GetTimezones>
    </ReadContentServiceRequest>
  </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>
    <ReadContentServiceResponse xmlns="http://api.messagelabs.com/2005/01/Customer">
      <ContentService>
        <OptimisticLockValue>base64Binary</OptimisticLockValue>
        <CustomerId>int</CustomerId>
        <DomainId>int</DomainId>
        <UseDomainDefaultSettings>boolean</UseDomainDefaultSettings>
        <AdministratorEmailAddress>string</AdministratorEmailAddress>
        <DefaultTimeZone>string</DefaultTimeZone>
        <AdministratorNotificationSettings>
          <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
          <CustomEmailSubject>string</CustomEmailSubject>
          <CustomEmailBody>string</CustomEmailBody>
          <DefaultEmailSubject>string</DefaultEmailSubject>
          <DefaultEmailBody>string</DefaultEmailBody>
        </AdministratorNotificationSettings>
        <SenderNotificationSettings>
          <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
          <CustomEmailSubject>string</CustomEmailSubject>
          <CustomEmailBody>string</CustomEmailBody>
          <DefaultEmailSubject>string</DefaultEmailSubject>
          <DefaultEmailBody>string</DefaultEmailBody>
        </SenderNotificationSettings>
        <RecipientNotificationSettings>
          <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
          <CustomEmailSubject>string</CustomEmailSubject>
          <CustomEmailBody>string</CustomEmailBody>
          <DefaultEmailSubject>string</DefaultEmailSubject>
          <DefaultEmailBody>string</DefaultEmailBody>
        </RecipientNotificationSettings>
        <NotificationSenderEmailAddress>string</NotificationSenderEmailAddress>
        <SubjectTag>string</SubjectTag>
        <SubjectTagPosition>Unknown or Prepend or Append</SubjectTagPosition>
      </ContentService>
      <TotalUserCount>int</TotalUserCount>
      <Rules>
        <ContentRule>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <DomainId>int</DomainId>
          <CustomerId>int</CustomerId>
          <RuleId>int</RuleId>
          <Name>string</Name>
          <Conditions>
            <ContentCondition xsi:nil="true" />
            <ContentCondition xsi:nil="true" />
          </Conditions>
          <Action>Unknown or LogOnly or CompressAttachments or BlockAndDelete or TagWithHeader or CopyToAdministrator or RedirectToAdministrator or TagSubjectLine or Quarantine</Action>
          <CustomAdministratorNotificationAddress>string</CustomAdministratorNotificationAddress>
          <LexicalScope>Unknown or EmailHeader or EmailSubject or EmailBody or Attachment or All</LexicalScope>
          <Direction>Unknown or Inbound or Outbound or InboundOrOutbound</Direction>
          <UseCustomAdministratorRedirectEmailAddress>boolean</UseCustomAdministratorRedirectEmailAddress>
          <UseCustomAdministratorNotificationAddress>boolean</UseCustomAdministratorNotificationAddress>
          <CustomAdministratorRedirectEmailAddress>string</CustomAdministratorRedirectEmailAddress>
          <AdministratorNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </AdministratorNotificationSettings>
          <SenderNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </SenderNotificationSettings>
          <RecipientNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </RecipientNotificationSettings>
          <ScanOfficeDocuments>boolean</ScanOfficeDocuments>
          <UseDefaultSubjectTag>boolean</UseDefaultSubjectTag>
          <SubjectTag>string</SubjectTag>
          <SubjectTagPosition>Unknown or Prepend or Append</SubjectTagPosition>
          <SenderConditionsOperator>Unknown or All or Any</SenderConditionsOperator>
          <RecipientConditionsOperator>Unknown or All or Any</RecipientConditionsOperator>
          <EmailConditionsOperator>Unknown or All or Any</EmailConditionsOperator>
          <AttachmentConditionsOperator>Unknown or All or Any</AttachmentConditionsOperator>
          <RuleOperator>Unknown or All or Any</RuleOperator>
          <IsActive>boolean</IsActive>
          <LastChangedDate>dateTime</LastChangedDate>
          <LastChangedBy>string</LastChangedBy>
          <IsCopiableToAnotherDomain>boolean</IsCopiableToAnotherDomain>
          <ServiceType>string</ServiceType>
        </ContentRule>
        <ContentRule>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <DomainId>int</DomainId>
          <CustomerId>int</CustomerId>
          <RuleId>int</RuleId>
          <Name>string</Name>
          <Conditions>
            <ContentCondition xsi:nil="true" />
            <ContentCondition xsi:nil="true" />
          </Conditions>
          <Action>Unknown or LogOnly or CompressAttachments or BlockAndDelete or TagWithHeader or CopyToAdministrator or RedirectToAdministrator or TagSubjectLine or Quarantine</Action>
          <CustomAdministratorNotificationAddress>string</CustomAdministratorNotificationAddress>
          <LexicalScope>Unknown or EmailHeader or EmailSubject or EmailBody or Attachment or All</LexicalScope>
          <Direction>Unknown or Inbound or Outbound or InboundOrOutbound</Direction>
          <UseCustomAdministratorRedirectEmailAddress>boolean</UseCustomAdministratorRedirectEmailAddress>
          <UseCustomAdministratorNotificationAddress>boolean</UseCustomAdministratorNotificationAddress>
          <CustomAdministratorRedirectEmailAddress>string</CustomAdministratorRedirectEmailAddress>
          <AdministratorNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </AdministratorNotificationSettings>
          <SenderNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </SenderNotificationSettings>
          <RecipientNotificationSettings>
            <NotificationUsage>Unknown or SendNoNotification or SendCustomNotification or SendDefaultNotification</NotificationUsage>
            <CustomEmailSubject>string</CustomEmailSubject>
            <CustomEmailBody>string</CustomEmailBody>
            <DefaultEmailSubject>string</DefaultEmailSubject>
            <DefaultEmailBody>string</DefaultEmailBody>
          </RecipientNotificationSettings>
          <ScanOfficeDocuments>boolean</ScanOfficeDocuments>
          <UseDefaultSubjectTag>boolean</UseDefaultSubjectTag>
          <SubjectTag>string</SubjectTag>
          <SubjectTagPosition>Unknown or Prepend or Append</SubjectTagPosition>
          <SenderConditionsOperator>Unknown or All or Any</SenderConditionsOperator>
          <RecipientConditionsOperator>Unknown or All or Any</RecipientConditionsOperator>
          <EmailConditionsOperator>Unknown or All or Any</EmailConditionsOperator>
          <AttachmentConditionsOperator>Unknown or All or Any</AttachmentConditionsOperator>
          <RuleOperator>Unknown or All or Any</RuleOperator>
          <IsActive>boolean</IsActive>
          <LastChangedDate>dateTime</LastChangedDate>
          <LastChangedBy>string</LastChangedBy>
          <IsCopiableToAnotherDomain>boolean</IsCopiableToAnotherDomain>
          <ServiceType>string</ServiceType>
        </ContentRule>
      </Rules>
      <Lists>
        <ContentList>
          <CustomerId>int</CustomerId>
          <DomainId>int</DomainId>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <ListId>int</ListId>
          <Scope>Unknown or Condition or Domain or Customer or Global</Scope>
          <Type>Unknown or MimeType or FileName or Domain or Content or Template or SelectedTemplate or Url</Type>
          <Name>string</Name>
          <Entries>
            <string>string</string>
            <string>string</string>
          </Entries>
          <UsedInRulesCount>int</UsedInRulesCount>
          <UsedInSuperListsCount>int</UsedInSuperListsCount>
          <IsSuperList>boolean</IsSuperList>
          <SubListIds>
            <int>int</int>
            <int>int</int>
          </SubListIds>
          <ServiceType>string</ServiceType>
        </ContentList>
        <ContentList>
          <CustomerId>int</CustomerId>
          <DomainId>int</DomainId>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <ListId>int</ListId>
          <Scope>Unknown or Condition or Domain or Customer or Global</Scope>
          <Type>Unknown or MimeType or FileName or Domain or Content or Template or SelectedTemplate or Url</Type>
          <Name>string</Name>
          <Entries>
            <string>string</string>
            <string>string</string>
          </Entries>
          <UsedInRulesCount>int</UsedInRulesCount>
          <UsedInSuperListsCount>int</UsedInSuperListsCount>
          <IsSuperList>boolean</IsSuperList>
          <SubListIds>
            <int>int</int>
            <int>int</int>
          </SubListIds>
          <ServiceType>string</ServiceType>
        </ContentList>
      </Lists>
      <Groups>
        <ContentUserGroup>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <UserGroupId>int</UserGroupId>
          <CustomerId>int</CustomerId>
          <DomainId>int</DomainId>
          <Name>string</Name>
          <MemberCount>int</MemberCount>
          <UsedInRuleCount>int</UsedInRuleCount>
          <GroupType>string</GroupType>
          <LastModifiedDate>dateTime</LastModifiedDate>
        </ContentUserGroup>
        <ContentUserGroup>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <UserGroupId>int</UserGroupId>
          <CustomerId>int</CustomerId>
          <DomainId>int</DomainId>
          <Name>string</Name>
          <MemberCount>int</MemberCount>
          <UsedInRuleCount>int</UsedInRuleCount>
          <GroupType>string</GroupType>
          <LastModifiedDate>dateTime</LastModifiedDate>
        </ContentUserGroup>
      </Groups>
      <Users>
        <ContentUser>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <UserId>int</UserId>
          <Name>string</Name>
          <MemberOfGroupsCount>int</MemberOfGroupsCount>
        </ContentUser>
        <ContentUser>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <UserId>int</UserId>
          <Name>string</Name>
          <MemberOfGroupsCount>int</MemberOfGroupsCount>
        </ContentUser>
      </Users>
      <TimeZones>
        <string>string</string>
        <string>string</string>
      </TimeZones>
      <HasUQ>boolean</HasUQ>
    </ReadContentServiceResponse>
  </soap:Body>
</soap:Envelope>