Xojo Plugin

Get a Mail-Merge Replacement String by Pattern

See more Email Object Examples

Demonstrates the Chilkat Email.GetReplaceString2 method, which returns the replacement string for a previously-defined pattern/replacement pair, looked up by the pattern itself (a mail-merge feature). This example defines two pairs and looks up the replacement for one pattern by name.

Background: Where GetReplaceString fetches a replacement by its numeric position, GetReplaceString2 fetches it by the pattern — convenient when you already know the token (say FIRST_NAME) and just want its configured substitution without scanning the whole list.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

//  Demonstrates the GetReplaceString2 method, which returns the replacement string for a
//  previously-defined pattern/replacement pair, looked up by the pattern itself (a
//  mail-merge feature).

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

Dim success As Boolean
success = email.SetReplacePattern("FIRST_NAME","John")
success = email.SetReplacePattern("CITY","Denver")

//  Look up the replacement for a specific pattern.
Dim repl As String
repl = email.GetReplaceString2("FIRST_NAME")
System.DebugLog("FIRST_NAME -> " + repl)