PHP Extension

Get an Alternative Body into a BinData

Demonstrates the Chilkat Email.GetAlternativeBodyBd method, which copies the contents of the Nth alternative body into a BinData object. The first alternative body is at index 0, and it should only be called when NumAlternatives is greater than 0. This example builds a message with plain-text and HTML alternatives and copies the first into a BinData.

Background: This is the binary counterpart to GetAlternativeBody (which returns text). Reading an alternative into a BinData preserves the exact bytes — important when a body part uses a binary or unusual transfer encoding, or when you intend to hash it or write it out verbatim rather than decode it to a string.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the GetAlternativeBodyBd method, which copies the contents of the Nth
//  alternative body into a BinData object.  The first alternative body is at index 0; call
//  only when NumAlternatives is greater than 0.

$email = new CkEmail();
$email->put_Subject('GetAlternativeBodyBd example');

$email->SetTextBody('This is the plain-text alternative.','text/plain');
$email->AddHtmlAlternativeBody('<html><body>This is the HTML alternative.</body></html>');

//  Copy the first alternative body (index 0) into a BinData object.
$bd = new CkBinData();

$success = $email->GetAlternativeBodyBd(0,$bd);
if ($success == false) {
    print $email->lastErrorText() . "\n";
    exit;
}

print 'Alternative 0 size (bytes) = ' . $bd->get_NumBytes() . "\n";

?>