Xojo Plugin

Define a Mail-Merge Replacement Pattern

See more Email Object Examples

Demonstrates the Chilkat Email.SetReplacePattern method, which defines a mail-merge replacement pair. The first argument is the pattern to find and the second is the replacement text. When the email is sent, the patterns are replaced in the bodies and header fields. This example defines two pairs and prints the count.

Background: This is Chilkat's built-in mail merge. You compose one message with placeholder tokens (like FIRST_NAME or CITY), register each token and its value with SetReplacePattern, and the substitutions are applied at send time — personalizing a bulk mailing without building a separate message for every recipient. Read the pairs back with GetReplacePattern and GetReplaceString.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

//  Demonstrates the SetReplacePattern method, which defines a mail-merge replacement pair.
//  The first argument is the pattern to find and the second is the replacement text.  When the email is sent,
//  the patterns are replaced in the bodies and header fields.

Dim email As New Chilkat.Email
email.Subject = "Hello FIRST_NAME"
email.Body = "Dear FIRST_NAME, welcome to CITY."

//  Define two mail-merge replacement pairs.
Dim success As Boolean
success = email.SetReplacePattern("FIRST_NAME","John")
success = email.SetReplacePattern("CITY","Denver")

System.DebugLog("NumReplacePatterns = " + Str(email.NumReplacePatterns))