PHP Extension

Clear an Email Object

Demonstrates the Chilkat Email.Clear method, which removes the current message content — recipients, headers, body representations, attachments, related items, and embedded messages — leaving an empty email object. This example builds a message with a recipient and attachment, clears it, and prints the counts before and after.

Background: Reusing a single Email object across many operations is efficient, but leftover state from a previous message could leak into the next. Clear resets the object completely, giving you a clean slate — the safe way to start a fresh message without allocating a new object.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

//  Demonstrates the Clear method, which removes the current message content, including
//  recipients, headers, body representations, attachments, related items, and embedded
//  messages -- leaving an empty email object.

$email = new CkEmail();
$email->put_Subject('A message');
$email->put_Body('Some body text.');
$email->AddTo('Bob','bob@example.com');
$email->AddStringAttachment('notes.txt','Some notes.');

print 'NumTo before clear = ' . $email->get_NumTo() . "\n";
print 'NumAttachments before clear = ' . $email->get_NumAttachments() . "\n";

//  Remove all content, resetting the email object.
$email->Clear();

print 'NumTo after clear = ' . $email->get_NumTo() . "\n";
print 'NumAttachments after clear = ' . $email->get_NumAttachments() . "\n";

?>