Is this really the version you are looking for? Kentico Xperience 11 Documentation is no longer updated. Use the switcher in the header to choose your product version.
This page lists macro expressions available solely within the Email marketing application. To facilitate easy access, individual macro expressions are exposed via the following objects:
To add these expressions, click Insert macro () on the editor toolbar and select the appropriate option under the Context specific objects section.
Notes
The Recipient entity exposes the following properties of individual recipients:
Property | Return type | Description |
|---|---|---|
FirstName | string | Resolves into the First name property of the recipient, as specified in the associated contact information. |
LastName | string | Resolves into the Last name property of the recipient, as specified in the associated contact information. |
string | Resolves into the Email property of the recipient, as specified in the associated contact information. | |
PersonaID | int | Resolves into the PersonaID property of the recipient, which identifies the persona assigned to the recipient. |
Note
When processing macros for marketing emails, the system uses two separate resolving phases:
If you need to use variables from general macros within macros containing the Recipient entity, add the |(resolver)subscriber parameter to the end of the expression that defines the variables. For example:
{% defaultText = "Hello there!" |(resolver)subscriber %}
{% Recipient.FirstName == String.Empty ? defaultText : "Hello, " + Recipient.FirstName + "!"; %}The (resolver)subscriber parameter added to the first macro ensures that the expression is resolved in the second phase along with the second Recipient macro.
Important: Only use the (resolver)subscriber macro parameter for scenarios where variable sharing is necessary. The system resolves such expressions separately for each recipient, which may reduce performance when sending a large number of emails.
If no recipients are available when previewing emails containing the Recipient macro, a fake contact with name Anthony Stark is used.
The Email entity exposes properties of individual emails.
Note: The Emailentity and all its macros are only available when editing email templates of the Email type and within the content of marketing email issues based on these templates.
Property | Return type | Description | Notes |
|---|---|---|---|
Name | string | Resolves into the Name property of the given email. | |
Subject | string | Resolves into the Subject property of the given email. | |
Preheader | string | Resolves into the Preheaderproperty of the given email. | The usage of this macro in open conditions or loops is not supported. |
SenderName | string | Resolves into the Sender nameproperty of the given email. | |
SenderEmail | string | Resolves into the Sender email addressproperty of the given email. | |
ViewInBrowserUrl | string | Resolves into a URL that allows recipients to view the email in a browser. |
The EmailFeed entity exposes the following properties of individual email feeds:
Property | Return type | Description | Notes |
|---|---|---|---|
Name | string | Resolves into the Name property of the email feed under which the macro resolves. | |
SubscriptionConfirmationUrl | string | Resolves into a link to the subscription approval page, as defined by the Approval page URL property of the given newsletter. | Only available for Double opt-in templates. |
UnsubscribeFromEmailFeedUrl | string | Resolves into a link to the unsubscription page, as defined by the Unsubscription page URL property of the given email feed. | |
UnsubscribeFromAllEmailFeedsUrl | string | Resolves into a link to the unsubscription page, as defined by the Unsubscription page URL property of the given email feed. |
Furthermore, the following macro method can be used with the EmailFeed entity.
Method | Return type | Parameters | Description |
|---|---|---|---|
GetAbsoluteUrl | string |
| Converts a relative path passed by the relativePath parameter into an absolute URL (using the Base URL configured for the email feed represented by the EmailFeed entity). Example: {% EmailFeed.GetAbsoluteUrl("/graphics/image.png") %} |