Keyword Replacements
Last Updated: 24 Jan 2019
bulkmail|asset|5.5.2.0
This chapter outlines the keyword replacements than can be used on the Bulkmail assets within Squiz Matrix.
Bookmarks to the headings on this page:
Bulkmail Content
You can personalise the content of the email through the use of keyword replacements. For example, you can use the recipient name or email address within the email to personalise the information being sent. If you are sending the email to users within your system, the list of available keyword replacements that can be used for these users is outlined in the table below.
| Keyword Replacement | Information Shown |
|---|---|
| %recipient_asset_attribute_username% | This will show the username from the user account. |
| %recipient_asset_attribute_first_name% | This will show the first name from the user account. |
| %recipient_asset_attribute_last_name% | This will show the last name from theuser account. |
| %recipient_asset_attribute_email% | This will show the email address from the user account. |
If you are sending the email to Bulkmail Users, the list of available keyword replacements that can be used for these users is outlined in the table below.
| Keyword Replacement | Information Shown |
|---|---|
| %recipient_asset_attribute_name% | This will show the name from the Bulkmail User. |
| %recipient_asset_attribute_email% | This will show the email address from the Bulkmail User. |
Bulkmail Subscribe Page
The following keyword replacements can be used on a Bulkmail Subscribe Page.
Logged In Layout Bodycopy
A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Logged In Layout Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available are outlined in the table below.
| Keyword Replacement | Information Shown |
|---|---|
| %error_messages_list% | This will show any errors that occur when the user clicks on the submit button. |
| %success_messages_list% | This will show the successful messages that occur when the user clicks on the submit button. |
| %current_subscriptions% | This will show the list of User Groups the current logged in user is subscribed to or linked under. |
| %subscriptions_picker% | This will show a list of User Groups the user can subscribe to. |
| %unsubscriptions_picker% | This will show a list of User Groups the user can unsubscribe from. |
| %user_name% | This will show the user name of the currently logged in user. The user will not be able to edit these details on this screen. |
| %user_short_name% | This will show the short name of the currently logged in user. The user will not be able to edit these details on this screen. |
| %user_email% | This will show the email address of the currently logged in user. The user will not be able to edit these details on this screen. |
| %subscribe_user_name% | This will show a field where the user can enter their name for their bulkmail user asset. |
| %subscribe_email_address% | This will show a field where the user can enter their email address where they wish to receive the email. |
| %commit_button% | This will show a button to allow your users to submit their details entered on the Bulkmail Subscribe Page. |
Not Logged In Layout Bodycopy
A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Not Logged In Layout Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available are outlined in the table below.
| Keyword Replacement | Information Shown |
|---|---|
| %error_messages_list% | This will show any errors that occur when the user clicks on the submit button. |
| %success_messages_list% | This will show the successful messages that occur when the user clicks on the submit button. |
| %subscriptions_picker% | This will show a list of User Groups the user can subscribe to. |
| %unsubscriptions_picker% | This will show a list of User Groups the user can unsubscribe from. |
| %subscribe_user_name% | This will show a field where the user can enter their name for their bulkmail user asset. |
| %subscribe_email_address% | This will show a field where the user can enter their email address where they wish to receive the email. |
| %commit_button% | This will show a button to allow your users to submit their details entered on the Bulkmail Subscribe Page. |