Lua Requires Chilkat v11.0.0+

How to Access Parts of a multipart/related HTTP Response

See more HTTP Examples

Demonstrates how to access the parts of a multipart/related response. This example sends a ficticious multipart/related request, and handles a ficticious multipart/related response.

We send the following multipart/related request:

Content-Type: multipart/related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_1744155.1118953559416"
Content-Length: 3453
SOAPAction: "some-SOAP-action"

------=_Part_1_4558657.1118953559446
Content-Type: application/xop+xml; type="text/xml"; charset=utf-8

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Detail xmlns="http://example.org/mtom/data">
      <image>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
      </image>
    </Detail>
  </soap:Body>
</soap:Envelope>

------=_Part_1_4558657.1118953559446
Content-Type: image/jpeg
Content-ID: <5aeaa450-17f0-4484-b845-a8480c363444@example.org>


... binary data ...

Lua

local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local http = chilkat.Http.new()

local soapXml = chilkat.Xml.new()

-- Build the following SOAP XML

-- <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
--   <soap:Body>
--     <Detail xmlns="http://example.org/mtom/data">
--       <image>
--         <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
--       </image>
--     </Detail>
--   </soap:Body>
-- </soap:Envelope>

soapXml.tag = "soap:Envelope"
soapXml:add_attribute("xmlns:soap", "http://schemas.xmlsoap.org/soap/envelope/")
soapXml:update_attr_at("soap:Body|Detail", true, "xmlns", "http://example.org/mtom/data")
soapXml:update_attr_at("soap:Body|Detail|image|xop:Include", true, "xmlns:xop", "http://www.w3.org/2004/08/xop/include")
soapXml:update_attr_at("soap:Body|Detail|image|xop:Include", true, "href", "cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org")

soapXml.emit_xml_decl = false
local xmlBody = soapXml:get_xml()
print(xmlBody)

local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
req.path = "/something/someTarget"

req.content_type = "multipart/related; start-info=\"text/xml\"; type=\"application/xop+xml\""
req:add_header("SOAPAction", "some-SOAP-action")

local success = req:add_string_for_upload2("", "", xmlBody, "utf-8", "application/xop+xml; type=\"text/xml\"; charset=utf-8")

-- The bytes will be sent as binary (not base64 encoded).
success = req:add_file_for_upload2("", "qa_data/jpg/starfish.jpg", "image/jpeg")

-- The JPEG data is the 2nd sub-part, and therefore is at index 1 (the first sub-part is at index 0)
success = req:add_sub_header(1, "Content-ID", "<5aeaa450-17f0-4484-b845-a8480c363444@example.org>")

http.follow_redirects = true

local useTls = true
local resp = chilkat.HttpResponse.new()
success = http:http_sreq("www.example.org", 443, useTls, req, resp)
if not success then
    print(http.last_error_text)
    return
end

-- Imagine the HTTP response is multipart related and is something like this:

-- HTTP/1.1 200 OK
-- Cache-Control: no-cache, no-store
-- Pragma: no-cache
-- Transfer-Encoding: chunked
-- Content-Type: multipart/related; boundary=------------080001080500020607080905
-- Expires: -1
-- Server: Microsoft-IIS/10.0
-- X-AspNet-Version: 4.0.30319
-- X-Powered-By: ASP.NET
-- Date: Wed, 19 Feb 2020 15:27:06 GMT
--
-- --------------080001080500020607080905
-- Content-Type: application/xop+xml; charset=iso-8859-1
-- Content-Id: RootPart
-- Content-Transfer-Encoding: binary
--
-- <?xml version="1.0" encoding="iso-8859-1"?>
-- <soapenv:Envelope xmlns:xcpt="...">
--   <soapenv:Header />
--   <soapenv:Body>
--     <xres:Transport profile="http://something.example.com/..." version="1.4">
--       <xres:TransportHeader>
--     ...
--     ...
--       </xres:TransportHeader>
--       <xres:TransportBody />
--     </xres:Transport>
--   </soapenv:Body>
-- </soapenv:Envelope>
-- --------------080001080500020607080905--

-- To get the XML, load the full MIME of the response into a Chilkat MIME object.  Then get the body of the 1st sub-part.
local mime = chilkat.Mime.new()
mime:load_mime(resp.full_mime)

-- Your code might verify that the Content-Type is indeed multipart/related.
print(mime.content_type)
print("num parts = " .. mime.num_parts)

-- Assuming it is, and the number of sub-parts is > 0
if mime.num_parts > 0 then
    local part0 = chilkat.Mime.new()
    mime:part_at(0, part0)

    -- The Content-Type (in this ficticious example) should be "application/xop+xml"
    print("sub-part Content-Type: " .. part0.content_type)
    -- Now get the XML
    local subPartXmlBody = part0:get_body_decoded()
    print(subPartXmlBody)
end