MagnetMail Web Service

Click here for a complete list of operations.

Authenticate

Authenticate

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

<?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>
    <Authenticate xmlns="http://www.magnetmail.net/">
      <username>string</username>
      <password>string</password>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://www.magnetmail.net/">
      <AuthenticateResult>
        <authenticated>boolean</authenticated>
        <sessionId>string</sessionId>
        <loginid>int</loginid>
        <login_name>string</login_name>
        <user_nbr>int</user_nbr>
        <partition_id>int</partition_id>
        <is_parent_mail_user>int</is_parent_mail_user>
        <parent_user_id>string</parent_user_id>
        <user_id>string</user_id>
      </AuthenticateResult>
    </AuthenticateResponse>
  </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:Body>
    <Authenticate xmlns="http://www.magnetmail.net/">
      <username>string</username>
      <password>string</password>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://www.magnetmail.net/">
      <AuthenticateResult>
        <authenticated>boolean</authenticated>
        <sessionId>string</sessionId>
        <loginid>int</loginid>
        <login_name>string</login_name>
        <user_nbr>int</user_nbr>
        <partition_id>int</partition_id>
        <is_parent_mail_user>int</is_parent_mail_user>
        <parent_user_id>string</parent_user_id>
        <user_id>string</user_id>
      </AuthenticateResult>
    </AuthenticateResponse>
  </soap12:Body>
</soap12:Envelope>