Unicode C++
Unicode C++
Using Replace Patterns in Email
See more Email Object Examples
Demonstrates how to use the replace patterns (mail-merge) feature in Chilkat MailMan.Chilkat Unicode C++ Downloads
#include <CkEmailW.h>
#include <CkMailManW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
bool success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// ---------------------------------------------------------------------
// Create an email template for sending.
CkEmailW emailTemplate;
// We're going to replace "FIRST_NAME" with an actual name.
// We arbitrarily chose "FIRST_NAME". We can choose anything, such as "CUSTOMER_NAME" or "THE_RECIPIENT_NAME"...
emailTemplate.put_Subject(L"Hello FIRST_NAME,");
emailTemplate.put_From(L"john@example.com");
emailTemplate.AddTo(L"FIRST_NAME",L"RECIPIENT_EMAIL");
emailTemplate.SetHtmlBody(L"<html><body><h2>Hello FIRST_NAME,</h2><p>Your order for PRODUCT_NAME has been shipped.</p></body></html>");
// If the email is saved to a file, we can see what it contains:
emailTemplate.SaveEml(L"qa_output/emailTemplate.eml");
// For example:
// MIME-Version: 1.0
// Date: Tue, 26 Apr 2022 07:10:52 -0500
// Message-ID: <715CF231A9F07B0B9FDB073518CD94138D791866@XYZ>
// Content-Type: text/html; charset=us-ascii
// Content-Transfer-Encoding: 7bit
// X-Priority: 3 (Normal)
// Subject: Hello FIRST_NAME,
// From: john@example.com
// To: FIRST_NAME <RECIPIENT_EMAIL>
//
// <html><body><h2>Hello FIRST_NAME,</h2><p>Your order for PRODUCT_NAME has been shipped.</p></body></html>
// ---------------------------------------------------------------------
// Demonstrate replace patterns by setting and then rendering to MIME.
CkMailManW mailman;
emailTemplate.SetReplacePattern(L"FIRST_NAME",L"Elon");
emailTemplate.SetReplacePattern(L"RECIPIENT_EMAIL",L"elon.musk@example.com");
emailTemplate.SetReplacePattern(L"PRODUCT_NAME",L"Twitter Corporation");
// Render to MIME to see what we get.
// Note: When the MailMan sends an email, it renders the email to MIME and then sends.
// The rendering process is to do replacements, or possibly sign, encrypt, etc.
// When MailMan.SendEmail is called, internally the email is rendered, and the rendered email is sent.
// The equivalent to MailMan.Send email is to call email.RenderToMime followed by MailMan.SendMime.
const wchar_t *mime = mailman.renderToMime(emailTemplate);
wprintf(L"%s\n",mime);
// This is the rendered MIME:
// MIME-Version: 1.0
// Date: Tue, 26 Apr 2022 07:25:49 -0500
// Message-ID: <750582BCDC891C67B48CEE2293C08B902C3891E9@XYZ>
// Content-Type: text/html; charset=us-ascii
// Content-Transfer-Encoding: 7bit
// X-Priority: 3 (Normal)
// Subject: Hello Elon,
// From: john@example.com
// To: Elon <elon.musk@example.com>
//
// <html><body><h2>Hello Elon,</h2><p>Your order for Twitter Corporation has been shipped.</p></body></html>
// Note: When rendering, the Date and Message-ID headers are automatically regenerated.
// ---------------------------------------------------------------------
// An application can see what replacement patterns it previously set by calling SetReplacePattern multiple times.
int count = emailTemplate.get_NumReplacePatterns();
wprintf(L"Number of replace patterns: %d\n",count);
int i = 0;
while (i < count) {
// Note: The GetReplaceString method was found to not be working correctly. It was returning the same value as GetReplacePattern.
// It is fixed in Chilkat v9.5.0.91
wprintf(L"%s: %s\n",emailTemplate.getReplacePattern(i),emailTemplate.getReplaceString(i));
i = i + 1;
}
// Or lookup a replacement pattern by name:
const wchar_t *name = L"FIRST_NAME";
wprintf(L"%s = %s\n",name,emailTemplate.getReplaceString2(name));
// Sample output:
// Number of replace patterns: 3
// FIRST_NAME: Elon
// RECIPIENT_EMAIL: elon.musk@example.com
// PRODUCT_NAME: Twitter Corporation
// FIRST_NAME = Elon
// ---------------------------------------------------------------------
// Finally... demonstrate sending emails using the replacement patterns.
//
// Set our mail server settings..
mailman.put_SmtpHost(L"smtp.mail.us-west-2.awsapps.com");
mailman.put_SmtpSsl(true);
mailman.put_SmtpPort(465);
mailman.put_SmtpUsername(L"john@example.com");
mailman.put_SmtpPassword(L"the_password");
// Imagine we have data in JSON format, and we wish to send the templated email to each recipient...
//
// {
// "mail_merge" : [
// {
// "to": "mary@example.com",
// "name": "Mary",
// "product": "Widget 1"
// },
// {
// "to": "robert@example.com",
// "name": "Robert",
// "product": "Widget 2"
// }
// ...
// ]
// }
CkJsonObjectW json;
success = json.LoadFile(L"qa_data/json/mail_merge.json");
if (success == false) {
wprintf(L"%s\n",json.lastErrorText());
return;
}
const wchar_t *emailAddr = 0;
const wchar_t *firstName = 0;
const wchar_t *product = 0;
i = 0;
count = json.SizeOfArray(L"mail_merge");
while (i < count) {
json.put_I(i);
emailAddr = json.stringOf(L"mail_merge[i].to");
firstName = json.stringOf(L"mail_merge[i].name");
product = json.stringOf(L"mail_merge[i].product");
emailTemplate.SetReplacePattern(L"FIRST_NAME",firstName);
emailTemplate.SetReplacePattern(L"RECIPIENT_EMAIL",emailAddr);
emailTemplate.SetReplacePattern(L"PRODUCT_NAME",product);
success = mailman.SendEmail(emailTemplate);
if (success == false) {
wprintf(L"%s\n",mailman.lastErrorText());
return;
}
wprintf(L"Send email to %s\n",emailAddr);
i = i + 1;
}
wprintf(L"Success.\n");
}