Get a Mail-Merge Replace Pattern

See more Email Object Examples

Demonstrates the Chilkat Email.GetReplacePattern method, which returns a replacement pattern — the search string — previously defined for mail-merge operations with SetReplacePattern. The index is zero-based. This example defines two patterns and enumerates them.

Background: In Chilkat's mail-merge, each entry is a pattern (a placeholder token such as FIRST_NAME) paired with a replacement string. GetReplacePattern retrieves the search side of the pair at a given index; GetReplaceString retrieves the matching replacement. Reading them back is useful for inspecting or logging exactly which substitutions will be applied when the message is sent.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkEmail.h>

void ChilkatSample(void)
    {
    HCkEmail email;
    int n;
    int i;

    //  Demonstrates the GetReplacePattern method, which returns a replacement pattern (the
    //  search string) previously defined for mail-merge operations with SetReplacePattern.
    //  The index is zero-based.

    email = CkEmail_Create();
    CkEmail_putSubject(email,"Hello FIRST_NAME");
    CkEmail_putBody(email,"Dear FIRST_NAME, welcome to CITY.");

    CkEmail_SetReplacePattern(email,"FIRST_NAME","John");
    CkEmail_SetReplacePattern(email,"CITY","Denver");

    n = CkEmail_getNumReplacePatterns(email);

    for (i = 0; i <= n - 1; i++) {
        printf("Pattern %d: %s\n",i,CkEmail_getReplacePattern(email,i));
    }



    CkEmail_Dispose(email);

    }