CMv4

Click here for a complete list of operations.

GetMessageSummaries

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 /cmv4/cmv4.asmx HTTP/1.1
Host: sandbox.dmhisp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ssl.certifiedmail.com/CMv4/GetMessageSummaries"

<?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>
    <GetMessageSummaries xmlns="https://ssl.certifiedmail.com/CMv4">
      <sessionKey>string</sessionKey>
      <folderId>int</folderId>
      <lastMessageIdReceived>int</lastMessageIdReceived>
    </GetMessageSummaries>
  </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>
    <GetMessageSummariesResponse xmlns="https://ssl.certifiedmail.com/CMv4">
      <GetMessageSummariesResult>
        <Summaries>
          <MessageSummarySoap>
            <CreateTime>dateTime</CreateTime>
            <FolderId>int</FolderId>
            <AttachmentCount>int</AttachmentCount>
            <MessageId>int</MessageId>
            <MessageSize>long</MessageSize>
            <MessageStatus>DirectMessageFailed or PendingUpload or PendingLicense or Pending or Restricted or Deleted or Retracted or Draft or EditMode or NoticeInQueue or NoticeSent or UnRead or Read or SentPlainText or NoticeError or Pop3Delivered or PushedZip or PushedPdf or DistributionRequestProcessed or DistributionRequestFailed or DirectMessageQueued or DirectMessageSent or DirectMessageDispatched or DirectMessageProcessed</MessageStatus>
            <SenderAddress>string</SenderAddress>
            <Subject>string</Subject>
          </MessageSummarySoap>
          <MessageSummarySoap>
            <CreateTime>dateTime</CreateTime>
            <FolderId>int</FolderId>
            <AttachmentCount>int</AttachmentCount>
            <MessageId>int</MessageId>
            <MessageSize>long</MessageSize>
            <MessageStatus>DirectMessageFailed or PendingUpload or PendingLicense or Pending or Restricted or Deleted or Retracted or Draft or EditMode or NoticeInQueue or NoticeSent or UnRead or Read or SentPlainText or NoticeError or Pop3Delivered or PushedZip or PushedPdf or DistributionRequestProcessed or DistributionRequestFailed or DirectMessageQueued or DirectMessageSent or DirectMessageDispatched or DirectMessageProcessed</MessageStatus>
            <SenderAddress>string</SenderAddress>
            <Subject>string</Subject>
          </MessageSummarySoap>
        </Summaries>
        <MoreMessagesAvailable>boolean</MoreMessagesAvailable>
      </GetMessageSummariesResult>
    </GetMessageSummariesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /cmv4/cmv4.asmx HTTP/1.1
Host: sandbox.dmhisp.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetMessageSummaries xmlns="https://ssl.certifiedmail.com/CMv4">
      <sessionKey>string</sessionKey>
      <folderId>int</folderId>
      <lastMessageIdReceived>int</lastMessageIdReceived>
    </GetMessageSummaries>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetMessageSummariesResponse xmlns="https://ssl.certifiedmail.com/CMv4">
      <GetMessageSummariesResult>
        <Summaries>
          <MessageSummarySoap>
            <CreateTime>dateTime</CreateTime>
            <FolderId>int</FolderId>
            <AttachmentCount>int</AttachmentCount>
            <MessageId>int</MessageId>
            <MessageSize>long</MessageSize>
            <MessageStatus>DirectMessageFailed or PendingUpload or PendingLicense or Pending or Restricted or Deleted or Retracted or Draft or EditMode or NoticeInQueue or NoticeSent or UnRead or Read or SentPlainText or NoticeError or Pop3Delivered or PushedZip or PushedPdf or DistributionRequestProcessed or DistributionRequestFailed or DirectMessageQueued or DirectMessageSent or DirectMessageDispatched or DirectMessageProcessed</MessageStatus>
            <SenderAddress>string</SenderAddress>
            <Subject>string</Subject>
          </MessageSummarySoap>
          <MessageSummarySoap>
            <CreateTime>dateTime</CreateTime>
            <FolderId>int</FolderId>
            <AttachmentCount>int</AttachmentCount>
            <MessageId>int</MessageId>
            <MessageSize>long</MessageSize>
            <MessageStatus>DirectMessageFailed or PendingUpload or PendingLicense or Pending or Restricted or Deleted or Retracted or Draft or EditMode or NoticeInQueue or NoticeSent or UnRead or Read or SentPlainText or NoticeError or Pop3Delivered or PushedZip or PushedPdf or DistributionRequestProcessed or DistributionRequestFailed or DirectMessageQueued or DirectMessageSent or DirectMessageDispatched or DirectMessageProcessed</MessageStatus>
            <SenderAddress>string</SenderAddress>
            <Subject>string</Subject>
          </MessageSummarySoap>
        </Summaries>
        <MoreMessagesAvailable>boolean</MoreMessagesAvailable>
      </GetMessageSummariesResult>
    </GetMessageSummariesResponse>
  </soap12:Body>
</soap12:Envelope>