ConfigService


Click here for a complete list of operations.

WriteIMSecurityService

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

<?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>
    <WriteIMSecurityServiceRequest xmlns="http://api.messagelabs.com/2005/01/Customer">
      <IMSecurityService>
        <OptimisticLockValue>base64Binary</OptimisticLockValue>
        <CustomerId>int</CustomerId>
        <ConfigurationType>None or ThreatNotification or Archiving or Disclaimer or ContentControl or AccessControl or All</ConfigurationType>
        <ThreatNotificationConfiguration>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <IsUseCustomNotification>boolean</IsUseCustomNotification>
          <DefaultNotification>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </DefaultNotification>
          <CustomNotification>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </CustomNotification>
        </ThreatNotificationConfiguration>
        <ArchivingConfiguration>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <IsTranscriptsEnabled>boolean</IsTranscriptsEnabled>
          <ArchiveEmailAddress>string</ArchiveEmailAddress>
          <ArchiveFormat>string</ArchiveFormat>
          <EmailFormat>string</EmailFormat>
        </ArchivingConfiguration>
        <DisclaimerConfiguration>
          <OptimisticLockValue>base64Binary</OptimisticLockValue>
          <IsInternalDisclaimerEnabled>boolean</IsInternalDisclaimerEnabled>
          <IsUseCustomInternalDisclaimer>boolean</IsUseCustomInternalDisclaimer>
          <DefaultInternalDisclaimer>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </DefaultInternalDisclaimer>
          <CustomInternalDisclaimer>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </CustomInternalDisclaimer>
          <IsExternalDisclaimerEnabled>boolean</IsExternalDisclaimerEnabled>
          <IsUseCustomExternalDisclaimer>boolean</IsUseCustomExternalDisclaimer>
          <DefaultExternalDisclaimer>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </DefaultExternalDisclaimer>
          <CustomExternalDisclaimer>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </CustomExternalDisclaimer>
        </DisclaimerConfiguration>
        <ContentControlConfiguration>
          <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>
          <Rules>
            <ContentRule xsi:nil="true" />
            <ContentRule xsi:nil="true" />
          </Rules>
          <Lists>
            <ContentList xsi:nil="true" />
            <ContentList xsi:nil="true" />
          </Lists>
        </ContentControlConfiguration>
        <AccessControlConfiguration>
          <DefaultNotification>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </DefaultNotification>
          <CustomNotification>
            <Id>int</Id>
            <Type>string</Type>
            <NotificationText>string</NotificationText>
          </CustomNotification>
        </AccessControlConfiguration>
      </IMSecurityService>
    </WriteIMSecurityServiceRequest>
  </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>
    <VoidResponse xmlns="http://api.messagelabs.com/2005/01/Customer" />
  </soap:Body>
</soap:Envelope>