Last updated: 2023-12-01
Works with CiviCRM 5.65 or higher.
This extension provides additional mail merge tokens for CiviCRM for use in emails, mass emails, or PDF letters.
The purpose of these tokens is to simplify including CRM data in emails, and to simplify the use of checksums in hyperlinks. Checksums are a great feature of CiviCRM that gives each recipient a unique URL that will be preloaded with the recipient's contact data (such as email, first name, last name or whatever data you are collecting.) The use of checksums saves time for the recipient when filling in your contribution pages, event registrations, petitions, webforms, and stand-alone profiles. It may also reduce the chance of duplicate contacts in your database due to poor data entry habits of your recipients.
Plus who can ever remember if the query string should include "cid=X" (such as for events and contribution pages) or "id=X" ( such as for stand-alone profiles.)
The event-related tokens simplify the process for preparing an email/newsletter that needs to include the upcoming events. Without these new tokens, the person preparing the email would need to copy and paste the various events from the calendar or Drupal events block, then massage the HTML. If you use this new event token and save it within your message template, you don't even have to touch the events section of the template when you reuse it in the future.
A) There is one token for each active contribution page. This token will produce a hyperlink that includes the checksum for the recipient. The clickable text will be the title of the contribution page.
B) There are several tokens for different time periods of upcoming events, such as 7 days, 3 weeks, and 3 months. After inserting the token into the body of the message, you can change the numeric portion of the token to whatever you prefer. This token will produce a nicely formatted HTML list of upcoming events, ie events starting after now() but before the end of the time period chosen. All event titles will be hyperlinked to the event information page. If the event allows for online registration, then there will also be a second hyperlink (including the checksum) pointing to the registration page. The text for this registration link will be the value in 'Registration Link Text' in the event configuration. The event listing will also include the event summary.
C) There is a token for each of the next X event registration pages ( i.e. future events that also have online registration enabled). The token includes the event ID which can be manually changed to any valid event ID. The hyperlink will include the checksum for the recipient.
D) There is one token for each active Petition. This token will produce a hyperlink that includes the checksum for the recipient. The clickable text will be the title of the petition.
E) There is one token for each active profile that does not use any fields that would prevent it from being used as a stand-alone profile form. For example, it does not create tokens for profiles that use participant or contribution fields. This token will produce a hyperlink that includes the checksum for the recipient. The clickable text will be the title of the profile.
F) There is one token for each published WebForm. If this extension is running under Drupal and the CiviCRM-WebForm integration module is installed, then one token will be created for each published WebForm. This logic checks if Drupal is in use before attempting to call any Drupal APIs. So this extension is safe to use with WordPress, Joomla and Stand-Alone.
G) There are a set of tokens under the category "Greetings" that provide convenient tokens for addressing married couples, households, and also single people. For example, Sometimes you want to use the nickname if not empty, otherwise fallback to their first name. (The greetings for couples currently only work for the English language)
- 'greetings.joint_casual' - 'Casual: Mike and Judy Kline (Uses nickname if available) '
- 'greetings.solo_casual' - 'Casual: Mike Kline (Uses nickname if available, does not show spouse) '
- 'greetings.joint_casual_firstname_lastname' - 'Casual first name and last name: Michael and Judith Kline'
- 'greetings.joint_casual_nickname_only' - 'Casual nickname only: Mike and Judy (Uses nickname if available)'
- 'greetings.solo_casual_nickname_only' - 'Casual nickname only: Mike(Uses nickname if available, does not show spouse)'
- 'greetings.joint_casual_firstname_only' - 'Casual first name only: Michael and Judith'
- 'greetings.joint_formal' - 'Formal: Mr. and Mrs. Kline'
- 'greetings.joint_formal_firstname' - 'Formal with first name: Mr. and Mrs. Michael Kline'