This help page is for Desktop Studio. This information is also available for CXone Studio.

Retrieves the inbound email content from the file server and stores it as a structured variable. The structured variable can be referenced anywhere regular variables can be referenced.

The Getemail action allows you to name the variables that contain the pieces of the email. For example, if you name the BodyTextVar variable "body", you can use the {body} variable anywhere curly braces are supported. This is especially useful in generating automatic responses.


Using a pipe delimiter ( | ) in an email subject line will cause the subject to be split (into an array), obligating you to piece the subject line back together.

Supported Script Types

The icon for the Email script type - a large @ symbol in a diamond.


Input Properties

These properties define data that the action uses when executing.




Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

ContainerVar The name of the structured variable that contains all other variables. EML is the default name.
SubjectVar The name of the variable that holds the subject of the message.
FromVar The name of the variable that contains the from address of the email.
ToVar The name of the variable that contains the To address of the email.
CCVar The name of the variable that contains the list of CC list of recipients on the email.
DateVar The name of the variable that contains the date of the email.
BodyTextVar The name of the variable that contains the body text of the email.
AttachmentListVar The name of the variable that contains the list of file attachments.
MaxBodyTextLength A picklist of the maximum length of the BodyTextVar string. By default, it is 2,000, but may be increased to 32,000.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.




Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.


Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.

Tips & Tricks

Technically, the Getemail action creates a C# class that can be invoked within a Snippet action.