MagnetMail Web Service


Click here for a complete list of operations.

getMessageList

Get A List Of Messages

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 /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.magnetmail.net/getMessageList"

<?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:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap:Header>
  <soap:Body>
    <getMessageList xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <createStartDate>dateTime</createStartDate>
      <createEndDate>dateTime</createEndDate>
      <sentStartDate>dateTime</sentStartDate>
      <sentEndDate>dateTime</sentEndDate>
      <archived>no or yes or all</archived>
      <hidden>no or yes or all</hidden>
      <hasFax>no or yes or all</hasFax>
      <hasEmail>no or yes or all</hasEmail>
    </getMessageList>
  </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>
    <getMessageListResponse xmlns="http://www.magnetmail.net/">
      <getMessageListResult>
        <Message>
          <message_id>int</message_id>
          <loginid>int</loginid>
          <user_id>string</user_id>
          <message_name>string</message_name>
          <createDate>dateTime</createDate>
          <lastSent>dateTime</lastSent>
        </Message>
        <Message>
          <message_id>int</message_id>
          <loginid>int</loginid>
          <user_id>string</user_id>
          <message_name>string</message_name>
          <createDate>dateTime</createDate>
          <lastSent>dateTime</lastSent>
        </Message>
      </getMessageListResult>
    </getMessageListResponse>
  </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 /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
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:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap12:Header>
  <soap12:Body>
    <getMessageList xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <createStartDate>dateTime</createStartDate>
      <createEndDate>dateTime</createEndDate>
      <sentStartDate>dateTime</sentStartDate>
      <sentEndDate>dateTime</sentEndDate>
      <archived>no or yes or all</archived>
      <hidden>no or yes or all</hidden>
      <hasFax>no or yes or all</hasFax>
      <hasEmail>no or yes or all</hasEmail>
    </getMessageList>
  </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>
    <getMessageListResponse xmlns="http://www.magnetmail.net/">
      <getMessageListResult>
        <Message>
          <message_id>int</message_id>
          <loginid>int</loginid>
          <user_id>string</user_id>
          <message_name>string</message_name>
          <createDate>dateTime</createDate>
          <lastSent>dateTime</lastSent>
        </Message>
        <Message>
          <message_id>int</message_id>
          <loginid>int</loginid>
          <user_id>string</user_id>
          <message_name>string</message_name>
          <createDate>dateTime</createDate>
          <lastSent>dateTime</lastSent>
        </Message>
      </getMessageListResult>
    </getMessageListResponse>
  </soap12:Body>
</soap12:Envelope>