context_v1_email Script API

Ben Tiedt — Fri, 08 Mar 2024 17:15:23 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:15: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
GetBoolValue
GetColorValue
GetCustomValue
GetDateTimeValue
GetDoubleValue
GetGuidValue
GetHtmlValue
GetIntValue
GetStringValue
GetUnitValue
GetUrlListValue
GetUrlValue

Properties

Name	Access	Type	Description
ApplicationId	Read	`Nullable of Guid`	Application Id
ApplicationTypeId	Read	`Nullable of Guid`	Application Type Id
Context	Read	`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`	Property Name	Required
defaultValue	`Boolean`	Default Value	Required

Returns

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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

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`	Property Name	Required
defaultValue	`DateTime`	Default Value	Required

Returns

DateTime

GetDoubleValue

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

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`String`	Property Name	Required
defaultValue	`Double`	Default Value	Required

Returns

Double

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`	Property Name	Required

Returns

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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

String

GetIntValue

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

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`String`	Property Name	Required
defaultValue	`Int32`	Default Value	Required

Returns

Int32

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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

String

GetUrlListValue

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

Velocity

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

JavaScript

var iListResponse = context_v1_email.GetUrlListValue(propertyName);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`String`	Property Name	Required

Returns

IList of 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`	Property Name	Required
defaultValue	`String`	Default Value	Required

Returns

String