context_v1_email Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:23 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:07:23

This extension is only available when rendering the implementation of an email. It is not generally available for use by widgets, themes, or automations.

Properties

Name	Access	Type	Description
ApplicationId	Read	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Application Id
ApplicationTypeId	Read	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Application Type Id
Context	Read	`[[Object Script API Type\|Object]]`	Email-specific contextual data

Methods

GetBoolValue

Returns the boolean email template configuration value specified by the property name

Velocity

#set($booleanResponse = $context_v1_email.GetBoolValue($propertyName, $defaultValue))

JavaScript

var booleanResponse = context_v1_email.GetBoolValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Boolean Script API Type\|Boolean]]`	Default Value	Required

Returns

[[Boolean Script API Type|Boolean]]

GetColorValue

Returns the color email template configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetColorValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetColorValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

GetCustomValue

Returns the custom email template configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetCustomValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetCustomValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

GetDateTimeValue

Returns the DateTime theme configuration value specified by the property name

Velocity

#set($dateTimeResponse = $context_v1_email.GetDateTimeValue($propertyName, $defaultValue))

JavaScript

var dateTimeResponse = context_v1_email.GetDateTimeValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[DateTime Script API Type\|DateTime]]`	Default Value	Required

Returns

[[DateTime Script API Type|DateTime]]

GetDoubleValue

Returns the double email template configuration value specified by the property name

Velocity

#set($numberResponse = $context_v1_email.GetDoubleValue($propertyName, $defaultValue))

JavaScript

var numberResponse = context_v1_email.GetDoubleValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required

Returns

[[Number Script API Type|Number]]

GetGuidValue

Returns the Guid email template configuration value specified by the property name

Velocity

#set($guidResponse = $context_v1_email.GetGuidValue($propertyName))

JavaScript

var guidResponse = context_v1_email.GetGuidValue(propertyName);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required

Returns

[[Guid Script API Type|Guid]]

GetHtmlValue

Returns the HTML theme configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetHtmlValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetHtmlValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

GetIntValue

Returns the integer email template configuration value specified by the property name

Velocity

#set($numberResponse = $context_v1_email.GetIntValue($propertyName, $defaultValue))

JavaScript

var numberResponse = context_v1_email.GetIntValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required

Returns

[[Number Script API Type|Number]]

GetStringValue

Returns the string theme configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetStringValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetStringValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

GetUnitValue

Returns the Unit email template configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetUnitValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetUnitValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

GetUrlListValue

Returns the URL list email template configuration value specified by the property name

Velocity

#set($listResponse = $context_v1_email.GetUrlListValue($propertyName))

JavaScript

var listResponse = context_v1_email.GetUrlListValue(propertyName);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required

Returns

[[List Script API Type|List]] of [[String Script API Type|String]]

GetUrlValue

Returns the URL email template configuration value specified by the property name

Velocity

#set($stringResponse = $context_v1_email.GetUrlValue($propertyName, $defaultValue))

JavaScript

var stringResponse = context_v1_email.GetUrlValue(propertyName, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

ToString

Velocity

#set($stringResponse = $context_v1_email.ToString())

JavaScript

var stringResponse = context_v1_email.ToString();

Returns

[[String Script API Type|String]]