Overview


This page details the built-in (standard) dynamic scripting variables for Email content in Engage, as opposed to custom attributes that may be defined by a subscriber list upload.


Standard dynamic scripting variables can be used to display values in the body of an email, or for conditional blocks.


Usage


Variables are grouped below into informational levels: Message Attributes, Subscriber Attributes, Dynamic Links, and Branding.


There are no case requirements for the key/variables themselves. For purposes of these guides, all variables are in lowercase. Values returned, however, are in the case stored in the database, unless output case is otherwise specified by the user.


This page does not go into detail about using these variables for conditional blocks. For help on that topic, please see Dynamic Text Blocks, Operands, and Conditional Statements.


 


Message Variables


The following dynamic scripting variables pull values from data on an email itself. They may be of use in a greeting, or in the body of message to identify the sender or to whom the recipient can reply.


|*message.to*|   


The "To" email address from the email, not the Subscriber's name. Pulled from the individual Subscriber record but stored at the Message level.


|*message.fromaddress*|    


Pulled from the Sender Profile set for the email in the Campaign Send wizard.


|*message.fromname*|    


Pulled from the Sender Profile set for the email in the Campaign Send wizard.


|*message.replytoaddress*|    


Pulled from the Sender Profile set for the email in the Campaign Send wizard.


|*message.replytoname*|   


Pulled from the Sender Profile set for the email in the Campaign Send wizard.


|*message.subject*|    


The email subject line entered in for the email in the Campaign Send wizard.


NOTE: This section of the reference guide does not cover setting up addresses and names for Sender Profiles For more information on this topic, see the Manage Sender Profiles topics listed under the Manage Your Account topic.


 


Subscriber Variables


There are a set of standard Subscriber-level variables available for dynamic scripting, as well as the ability for clients to call custom variables created with subscriber records. For information on Email Custom Subscriber Variables, see Email Custom Dynamic Scripting Variables.


Name Variables


The first set of standard dynamic subscriber variables are the subscriber Name variables, often used in the greeting of an email.


|*subscriber.firstname*|    


Pulled from the subscriber record for an email's recipient


|*subscriber.lastname*|    


Pulled from the subscriber record for an email's recipient


|*subscriber.fullname*|    


Concatenated from the firstname and lastname values.


 


Channel Values


There are also standard subscriber variables to pull the subscriber's channel values - email address or SMS/fax number.


The values for email, SMS, and fax are called by:


|*subscriber.email*|    


Pulled from the subscriber record for an email's recipient.


|*subscriber.sms*|    


Pulled from the subscriber record for an email's recipient.


|*subscriber.fax*|    


Pulled from the subscriber record for an email's recipient.


 


For backwards compatibility, these may also be called by:


|*subscriber.channels(email).address*|    


|*subscriber.channels(sms).number*|    


|*subscriber.channels(fax).number*|  


However, these methods are deprecated and may be removed in the future.


 


|*subscriber.key*|    


Pulled from the subscriber record for an email's recipient. The "Key" value is generally created automatically as the email address, SMS, or fax number - whichever is first found, in that order, when first uploading the subscriber. In some cases, however, a client may upload a specific chosen value for the Key instead. It may be unlikely that you will use this in an email, but it is included in this documentation for reference as it is a selection in the Dynamic Content dialog box.


You may find these of use in the body of an email to show the method of communication you will use with a subscriber.


 


Channel Enabled Values


There are also three values representing whether or not a communication channel is enabled for an individual subscriber - that is, whether or not they are opted in or out for methods of communication. Channels are enabled for subscribers by default upon initial upload in a subscriber list. Note that these functions are deprecated and kept solely for backward compatibility.


|*subscriber.channels(email).isenabled*|


Pulled from the subscriber record for an email's recipient


|*subscriber.channels(sms).isenabled*|


Pulled from the subscriber record for an email's recipient


|*subscriber.channels(fax).isenabled*|


Pulled from the subscriber record for an email's recipient


These return simply a TRUE or FALSE. For that reason, they are not likely to be of use if displayed in the body of an email. They are of greater use in conditional statements to display or hide blocks of text based on what channels a subscriber has signed up for. For more information on conditional statements, see Dynamic Text Blocks, Operands, and Conditional Statements.


 


Dynamic Link Variables


There are five pre-made dynamic scripting functions that can be used when creating the email in the Content screen. 


They are:


  • Link to the Preference Center for managing communication preferences
  • Global Unsubscribe from all Marketing Emails
  • Unsubscribe from all Subscriptions attached to the current email (Standard Campaigns)
  • Unsubscribe from a single Automated Campaign (formerly "automated programs")
  • View the email as a Web Page


These can be added to the body of an email from the Add Dynamic Content button in the email creation screen.


The Preferences link opens the subscriber's subscription opt-in/opt-out preferences without making modifications, allowing the user to change what methods of communication they are signed up for, before saving changes.


 


The Unsubscribe links are a one-click opt out. There are several versions of the Unsubscribe link:


  • Global Opt Out for Engage emails on Marketing Mail Streams
  • Subscription opt out only for Standard Campaigns
  • Automated Campaign Opt Out


The Global and Subscription opt-out links open the preference center, but automatically unsubscribe the email recipient from email communications. The Automated Campaign opt out sends the subscriber to a page stating their opt out has been processed.


The Global Opt out link opts the subscriber out of all email communication for all campaigns on Marketing mail streams, as well as from any Subscriptions related to the campaign the email is for.


The Subscription Opt Out link opts the subscriber out of all Marketing mail stream campaigns using that Subscription, but does not opt the subscriber out globally.


The Automated Campaign opt out link removes the subscriber from that specific Automated Campaign only.


 


The View as Web Page link is just that - it opens the email - with any dynamic scripting or custom content for the recipient - in a web browser.


While adding these to the email content with the Add Dynamic Content button is the easiest method, they can also be added with the following syntax:


  • Preferences: |*Url.PreferenceCenter*|
  • Global Optout: |*Url.Global.Optout*|
  • Opt Out Group Optout: |*Url.Subscription.Optout*|
  • Automated Campaign Optout: |*Url.Program.Optout*|
  • View as Web Page: |*Url.ViewAsWebpage*|


These links (except the View as Web Page) are for use with a default Preference Center. We can work with you to code links for custom sites/preference centers.


 


Branding Variables


You can also include variables pulled from your account's Branding settings. While not all are likely for regular use in email content, they may be used for other coding. For that reason, all dialog box options are included here.


 


|*Branding.ButtonColor*|


The HTML value for Button Color from your account's Branding.


|*Branding.Copyright*|


The Copyright text from your account's Branding.


|*Branding.Disclaimer*|


The Disclaimer text from your account's Branding.


|*Branding.FacebookURL*|


The link to your company's Facebook page from your account's Branding.


|*Branding.LinkColor*|


The HTML value for Link Color from your account's Branding.


|*Branding.Logo*|


The company logo image from your account's Branding.


|*Branding.MailingAddress*|


The Mailing Address text from your account's Branding.


|*Branding.PrimaryColor*|


The HTML value for Primary (text) Color from your account's Branding.


|*Branding.TwitterURL*|


The link to your company's Twitter page from your account's Branding.


|*Branding.YouTubeURL*|


The link to your company's YouTube page from your account's Branding.