DI# Classes and Methods for Messages

Returns true in the web version of the email, else returns false.

[[if (Config.isShowMessage) {]]
You are in the web version. 
// This text will be displayed in the web version of the email.
[[}]]

Returns true in a web archive, else returns false.

[[if (Config.isWebArchive) {]] 
You are in the web archive.
// This text will will be displayed in the web archive of the message.
[[}]]

Validates that the value is an integer.

Converter.isInt("123"); // Returns true

Converter.isInt("abc"); // Returns false

Validates that the value is a decimal.

Converter.isDecimal("1.23"); // Returns true

Converter.isDecimal("abc"); // Returns false

Validates that the value is a date & time.

Converter.isDateTime("2018.05.02 09:00:00"); // Returns true

Converter.isDateTime("abc"); // Returns false

Validates that the value is a date.

Converter.isDate("2018.05.02"); // Returns true

Converter.isDate("abc"); // Returns false

Validates that the value is a boolean.

Converter.isBool(1); // Returns true

Converter.isBool("1"); // Returns false

Validates that the value is a datasource.

Converter.isDatasource(1); // Returns true

Converts the value to a 32-bit integer.

Note: An exception will be raised if the object passed cannot be converted to an integer.

Converter.ToInt("123"); // Returns : 123

Converter.ToInt("I have 10 apples"); // Will raise an exception

Converts the value to a decimal number.

Note: An exception will be raised if the object passed cannot be converted to a decimal.

Converter.ToDecimal("1.2"); // Returns : 1.2

Converter.ToDecimal("pi = 3.1415"); // Will raise an exception

Converts an object to a date & time format.

Note: An exception will be raised if the object passed cannot be converted to a date/time format.

Converter.ToDateTime("2016.01.01 12:30:45"); 
// Returns a DateTime object that contains 2016.01.01 12:30:45

Converter.ToDateTime("Hello"); 
// Will raise an exception 

Converts the value to a date format.

Note: An exception will be raised if the object passed cannot be converted to a date.

Converter.ToDate("2016.01.01"); 
// Returns a date containing 2016.01.01 00:00:00

Converter.ToDate("Hello"); 
// Will raise an exception

Converts the value to a boolean.

Note: n exception will be raised if the object passed cannot be converted to a boolean.

 Converter.ToBool(1); // Returns : True

 Converter.ToBool(0); // Returns : False

 Converter.ToBool("Hello"); // Will raise an exception

Returns true if if it a test sending, else returns false.

[[if (Mailing.isTest) {]]
This is a test sending.
[[}]] 
// This content will only display in a test sending

Returns the date of the sending.

[[=Mailing.dtMailing;]] 
// Returns a full datetime of the moment of the sending

Returns the message name.

[[=Message.MessageName;]] 
// Displays the message name

Returns the ID of the communication type linked to the message.

 [[=Message.idCategory;]] 
// Displays the communication type ID

Returns the unique identifier of the message.

 [[=Message.idMessage;]] 
// Displays the ID of the message

Object containing the message parameters and their values.

[[=Message.Parameters.MyParameter;]] 
// Displays the value of "MyParameter"

Generates the URL to the "Tell a friend" form.

<a href="[[=Message.TellAFriend("OriginalSender","fr-CA");]]
" target="_blank">Send to a Friend</a> 
// Generates the link towards the english version of the form

Generates the URL to the specified operational link.

<a href="[[=Message.OpLink(1);]]">Lien opérationel</a> 
/* Generates the URL of the operational link 
   with the unique identifier of "1" 
*/

Generates the message read tag.

[[=Message.ReadTag();]] 
// Generates the message read tag

Generates the URL to the unsubscription form.

 <a href="[[=Message.Optout("fr-CA");]]">Désabonnement</a> 
// Generates the URL to the english unsubscription form

Generates the link to the web version of the email.

<a href="[[=Message.WebVersion(1,true);]]">Version web</a> 
// Generates the URL to the full screen web version

Returns a collection of the implicit consent identifiers linked to the communication type.

// If we assume that the communication type has two linked implicits 
Message.Category.idImplicitRightFlags // Returns the array [1,5]
Message.Category.idImplicitRightFlags[0] // Returns 1 
Message.Category.idImplicitRightFlags[1] // Returns 5

Returns a collection of the explicit consent identifiers linked to the communication type.

// If we assume that the communication type has two linked implicits
Message.Category.idOptinFlags// Returns the array [2,3]
Message.Category.idOptinFlags[0] // Returns 2
Message.Category.idOptinFlags[1] // Returns 3

Returns the unique identifier of the communication type.

Message.Category.idCategory 
// Displays the ID of the communication type 

Returns the name of the communication type.

Message.Category.Name 
// Displays the name of the communication type 

Denotes if the communication type is of administrative type by a true or false value.

Message.Category.IsAdministrative 
// Returns true or false

Displays specified content to screen.

[[Output.Write("MyValue");]]  // Displays MyValue to screen

Returns a DateTime object containing the current date and time.

[[=System.Now;]] 
// returns, for example: 2018-04-09 14:40:25

Returns the current culture of the application.

[[=System.Culture;]] 
// returns, for example: "en-CA"

Returns the string encoded with HTMLEntities.

[[=System.Encoding.HTMLEntities("My string");]] 
// Returns the encoding result

Returns the string encoded with Java1.

[[=System.Encoding.Java1("My string");]] 
// Returns the encoding result

Returns the string encoded with Java1.

[[=System.Encoding.Java2("My string");]] 
// Returns the encoding result

Returns the string encoded with URL.

[[=System.Encoding.URL("My string","utf-8");]] 
// Returns the encoding result

Examples of encoding formats that are accepted: UTF-8, ASCII, ISO-8859-1, Windows-1252

Returns the name of the culture containing the language (2 lower case characters), a hyphen and the region (2 upper case characters).

System.Environment.Culture.Name; // Returns "en-CA"

Returns the language (2 lowercase characters).

System.Environment.Culture.Language; // Returns "en"

Returns the region (2 uppercase characters).

System.Environment.Culture.Region; // Returns "CA"

Returns the distance between two geographic coordinates.

System.Geoloc.Distance(46.805719, -71.323384, 45.502065, -73.557709); 
// Returns 225,195974299394

Converts a postal code to a set of geographic coordinates.

System.Geoloc.GetPointFromCode("CA", "G1P 2J7").Latitude; 
// Returns the decimal 46.805719

System.Geoloc.GetPointFromCode("CA", "G1P 2J7").Longitude; 
// Returns the decimal -71.323384

Converts an object to a JSON formatted string.

System.Tools.JSON.Serialize(new[] {"Apple", "Orange", "Banana"}); 
// Returns : ["Apple","Orange","Banana"]

Converts a JSON formatted string to an object.

System.Tools.JSON.Deserialize("MyValue"); 
// Returns MyValue

System.Tools.JSON.Deserialize("['Apple','Orange','Banana']"); 
// Returns a list containg the three elements

Returns the greater inferior or equal integer to the specified number.

System.Tools.Math.Floor(1.5); // Returns 1

System.Tools.Math.Floor(1); // Returns 1

System.Tools.Math.Floor(1.99); // Returns 1

Returns the smallest superior or equal integer to the specified number.

System.Tools.Math.Ceiling(1.5); // Returns 2

System.Tools.Math.Ceiling(2); // Returns 2

System.Tools.Math.Ceiling(1.01); // Returns 2

System.Tools.Math.Round(1.68); // Returns 2

System.Tools.Math.Round(1.68, 1); // Returns 1,7

Returns "true" if code is valid, else returns "false".

Note: A code may only contain alphanumeric characters and underscores. The first character must be a letter, and it cannot end with an underscore.

System.Tools.Validators.EMail.isValidCode("myValidField"); 
// Returns True

System.Tools.Validators.EMail.isValidCode("invalidField_"); 
// Returns False

System.Tools.Validators.EMail.isValidCode("validField2"); 
// Returns True

System.Tools.Validators.EMail.isValidCode("1InvalidField"); 
// Returns False

Returns "True" if the email validates, else returns "False".

System.Tools.Validators.EMail.isValid("user@domain.com"); 
// Returns True

System.Tools.Validators.EMail.isValid("NomAccentué@domaine.com"); 
// Returns False

System.Tools.Validators.EMail.isValid("domain.com"); 
// Returns False

System.Tools.Validators.EMail.isValid("user@domain"); 
// Returns False

Returns the email domain.

System.Tools.Validators.EMail.GetDomain("user@domain.com"); 
// Returns : "domain.com"

System.Tools.Validators.EMail.GetDomain("domain.com"); 
// Returns an empty string

Uses the SHA1 method in order to convert a string to a byte array.

System.Tools.Hash.SHA1.GetBytes("My string"); 
// Returns a byte array

Returns the result of a SHA1 hash as a string.

System.Tools.Hash.SHA1.GetString("MyValue"); 
// Returns "DFFFEA589FCEA0A45711699422C7A20435B8B9A5"

Uses the SHA256 method in order to convert a string to a byte array.

System.Tools.Hash.SHA256.GetBytes("my string"); 
// Returns a byte array

Returns the result of a SHA256 hash as a string.

System.Tools.Hash.SHA256.GetString("MyValue"); 
// Returns "83527DED182C33A2ADFF553655A7D15492EA070F89566D3ED9A8AFD7519D0C1F"

Uses the MD5 method in order to convert a string to a byte array.

System.Tools.Hash.MD5.GetBytes("my string"); 
// Returns a byte array

Returns the result of an MD5 hash as a string.

System.Tools.Hash.MD5.GetString("MyValue"); 
// Returns "72F5D0C22D11F32C518782894629FB5A"

First name of the contact who filled the TellAFriend form.

[[=TellAFriend.Sender_FirstName;]] 
// Displays the contact's first name

Last name of the contact who filled out the TellAFriend form.

[[=TellAFriend.Sender_LastName;]] 
// Displays the contact's last name

Friend's first name.

[[=TellAFriend.Friend_FirstName;]] 
// Displays the friend's first name

Friend's last name.

[[=TellAFriend.Friend_LastName;]] 
// Displays the friend's last name

Comments left to the friend.

 [[=TellAFriend.Comments;]] 
// Displays the comments left to the friend

Returns the current message culture.

// In a message that has the culture "en-CA"
[[=Version.Culture;]] // Displays "en-CA" 
// The following conditiuon will display « English » 
[[if (Version.Culture == "fr-CA") {]]
Français 
[[}else{]] 
English 
[[}]]

Returns the unique identifier of the current message.

// In a message that has only one version
[[=Version.idMessageVersion;]] // Displays 1

Method that allows to determine if we are in edit mode.

[[if (VisualEditor.IsDesignMode()) {]] 
<div>This div is only visible in edit mode.</div> 
[[}]]

[[if (VisualEditor.IsDesignMode() == false) {]] 
<div>This div is not visible in edit mode.</div>
[[}]]

Method that allows to visually identify the edit zone in the visual editor.

datasource dsCustomDesignConfig = 
{ EditedProviders:{block_Layout.Styles}, 
ToolPosition:"Inside", ToolSide:"Top", 
ToolAlign:"Right", 
SmallDragHelper:true, 
EditedProvidersShouldOverride: true }; 
// Edit zone config

]] 
<div class="MainContent" 
[[ VisualEditor.EditZone(block_Layout, dsCustomDesignConfig);]]>
My content
</div> 
/* Visual edition of the block "block_Layout" 
will be available on the previous div, according 
to the config set previously*/
[[

Automatic translation according to context.

[[=VisualEditor.UICultureTranslate("Je suis", "I am");]] 
// If the application context is in french, "Je suis" will be displayed.  
// If the context is english, "I am" will be displayed