Chilkat Online Tools

ListMailboxExportJobs phpExt Example

Amazon WorkMail

<?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.

$rest = new CkRest();

$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');

// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('workmail');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://workmail.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('workmail.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

// The following code creates the JSON request body.
// The JSON created by this code is shown below.

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

$json = new CkJsonObject();
$json->UpdateInt('MaxResults',123);
$json->UpdateString('NextToken','string');
$json->UpdateString('OrganizationId','string');

// The JSON request body created by the above code:

// {
//   "MaxResults": number,
//   "NextToken": "string",
//   "OrganizationId": "string"
// }

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','WorkMailService.ListMailboxExportJobs');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('POST','/',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);

// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.

// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$NextToken = $jResp->stringOf('NextToken');
$i = 0;
$count_i = $jResp->SizeOfArray('Jobs');
while ($i < $count_i) {
    $jResp->put_I($i);
    $Description = $jResp->stringOf('Jobs[i].Description');
    $EndTime = $jResp->IntOf('Jobs[i].EndTime');
    $EntityId = $jResp->stringOf('Jobs[i].EntityId');
    $EstimatedProgress = $jResp->IntOf('Jobs[i].EstimatedProgress');
    $JobId = $jResp->stringOf('Jobs[i].JobId');
    $S3BucketName = $jResp->stringOf('Jobs[i].S3BucketName');
    $S3Path = $jResp->stringOf('Jobs[i].S3Path');
    $StartTime = $jResp->IntOf('Jobs[i].StartTime');
    $State = $jResp->stringOf('Jobs[i].State');
    $i = $i + 1;
}

// A sample JSON response body parsed by the above code:

// {
//   "Jobs": [
//     {
//       "Description": "string",
//       "EndTime": number,
//       "EntityId": "string",
//       "EstimatedProgress": number,
//       "JobId": "string",
//       "S3BucketName": "string",
//       "S3Path": "string",
//       "StartTime": number,
//       "State": "string"
//     }
//   ],
//   "NextToken": "string"
// }

?>