PHP

Get a Mail-Merge Replacement String by Index

Demonstrates the Chilkat Email.GetReplaceString method, which returns the replacement string for the Nth previously-defined pattern/replacement pair (a mail-merge feature). The index is zero-based and corresponds to the same index used by GetReplacePattern. This example defines two pairs and prints each pattern with its replacement.

Background: Pairing GetReplacePattern (the token to find) with GetReplaceString (the text to substitute) at the same index lets you walk the full mail-merge table. Retrieving a replacement by its position is handy when enumerating all substitutions; to look one up by its pattern instead, use GetReplaceString2.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Email;

// Demonstrates the GetReplaceString method, which returns the replacement string for the
// Nth previously-defined pattern/replacement pair (a mail-merge feature).  The index is
// zero-based and corresponds to the same index used by GetReplacePattern.

$email = new Email();
$email->Subject = 'Hello FIRST_NAME';
$email->Body = 'Dear FIRST_NAME, welcome to CITY.';

$email->SetReplacePattern('FIRST_NAME', 'John');
$email->SetReplacePattern('CITY', 'Denver');

$n = $email->NumReplacePatterns;
for ($i = 0; $i < $n; $i++) {
    echo $email->GetReplacePattern($i), ' -> ', $email->GetReplaceString($i), "\n";
}