(PHP Extension) Extract Files from Binary SOAP MTOM MIME

This example demonstrates how to extract files from a binary SOAP MTOM MIME document.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$mime = new CkMime();

// In this example, we have a MIME file containing 8bit (non-encoded) binary data,
// and it is what I call "headless".  MIME is headless when it omits
// the top-level header.  The file we have here begins with the first
// boundary string.

// The structure the MIME to be loaded is:

// multipart/mixed (inferred because it is headless)
//     application/xop+xml
//     image/jpeg
//     image/gif
//     image/gif
// 

$success = $mime->LoadMimeFile('qa_data/mime/headless_binary_soap_mtom_mime.mim');
if ($success != true) {
    print $mime->lastErrorText() . "\n";
    exit;
}

// The MIME file loaded in this example contains this:

// --uuid:e74486f4-52b0-44b6-b829-156810fae20d
// Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"
// Content-Transfer-Encoding: binary
// Content-ID: <root.message@cxf.apache.org>
// 
// <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"><soap:Body> ... </soap:Body></soap:Envelope>
// --uuid:e74486f4-52b0-44b6-b829-156810fae20d
// Content-Type: image/jpeg
// Content-Transfer-Encoding: binary
// Content-ID: <beee83b7-166c-494c-890a-def990e9887b-1496@cxf.apache.org>
// Content-Disposition: attachment;name="-2049913191"
// 
// BINARY DATA HERE...
// 
// --uuid:e74486f4-52b0-44b6-b829-156810fae20d
// Content-Type: image/gif
// Content-Transfer-Encoding: binary
// Content-ID: <beee83b7-166c-494c-890a-def990e9887b-1497@cxf.apache.org>
// Content-Disposition: attachment;name="-2049913188"
// 
// BINARY DATA HERE...
// 
// --uuid:e74486f4-52b0-44b6-b829-156810fae20d
// Content-Type: image/gif
// Content-Transfer-Encoding: binary
// Content-ID: <beee83b7-166c-494c-890a-def990e9887b-1498@cxf.apache.org>
// Content-Disposition: attachment;name="-2049913185"
// 
// BINARY DATA HERE...
// 
// --uuid:e74486f4-52b0-44b6-b829-156810fae20d--

// Get the number of MIME sub-parts.
$numParts = $mime->get_NumParts();

// The 1st part at index 0 is the application/xop+xml.  We're just going to extract the JPG and GIF image files..
$sbFilename = new CkStringBuilder();

$i = 1;
while ($i < $numParts) {
    // mp is a CkMime
    $mp = $mime->GetPart($i);

    // By looking at the MIME above, the "name" attribute of the Content-Disposition header field seems
    // to be the only possible name we can use for each image..
    $sbFilename->Append('qa_output/');
    $name = $mp->getHeaderFieldAttribute('Content-Disposition','name');
    $sbFilename->Append($name);
    $sbFilename->Append('.');
    $sbFilename->Append($mp->contentType());
    $numReplaced = $sbFilename->Replace('image/','');
    $mp->SaveBody($sbFilename->getAsString());
    print 'output file: ' . $sbFilename->getAsString() . "\n";

    $sbFilename->Clear();
    $i = $i + 1;
}

print 'Success.' . "\n";

?>