Skip to main content
Carrier object for EmailFlow.

​
Constructors

​
NSEmailFlow()

Initializes a new instance of the NSEmailFlow class.

​
Methods

​
GetEmailFlowId()

Gets the primary key (ID) for the EmailFlow.
Returns: CRMScript.Global.Integer - EmailFlow Id.

​
SetEmailFlowId(Integer)

Sets the primary key (ID) for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetStartOnlyOnce()

Gets whether a contact can start this flow only once.
Returns: CRMScript.Global.Bool - True if contact can only start once.

​
SetStartOnlyOnce(Bool)

Sets whether a contact can start this flow only once.
Returns: CRMScript.Global.Void

​
GetOverrideConsentSubscription()

Gets whether to override consent subscription.
Returns: CRMScript.Global.Bool - True to override consent subscription.

​
SetOverrideConsentSubscription(Bool)

Sets whether to override consent subscription.
Returns: CRMScript.Global.Void

​
GetFromType()

Gets the type of sender for the EmailFlow.
Returns: CRMScript.NetServer.EmailFromType - Sender type.

​
SetFromType(EmailFromType)

Sets the type of sender for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetFromName()

Gets the name of the sender for the EmailFlow.
Returns: CRMScript.Global.String - Sender name.

​
SetFromName(String)

Sets the name of the sender for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetFromAddr()

Gets the email address of the sender for the EmailFlow.
Returns: CRMScript.Global.String - Sender email address.

​
SetFromAddr(String)

Sets the email address of the sender for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetReplyToType()

Gets the reply-to type for the EmailFlow.
Returns: CRMScript.NetServer.EmailReplyToType - Reply-to type.

​
SetReplyToType(EmailReplyToType)

Sets the reply-to type for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetReplyToAddr()

Gets the reply-to email address for the EmailFlow.
Returns: CRMScript.Global.String - Reply-to email address.

​
SetReplyToAddr(String)

Sets the reply-to email address for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetReplyToName()

Gets the name for the reply-to address in the EmailFlow.
Returns: CRMScript.Global.String - Reply-to name.

​
SetReplyToName(String)

Sets the name for the reply-to address in the EmailFlow.
Returns: CRMScript.Global.Void

​
GetSmsSender()

Gets the SMS sender information for the EmailFlow.
Returns: CRMScript.Global.String - SMS sender information.

​
SetSmsSender(String)

Sets the SMS sender information for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetUseGoogleAnalytics()

Gets whether to use Google Analytics for the EmailFlow.
Returns: CRMScript.Global.Bool - True to use Google Analytics.

​
SetUseGoogleAnalytics(Bool)

Sets whether to use Google Analytics for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetGaSource()

Gets the Google Analytics source for the EmailFlow.
Returns: CRMScript.Global.String - Google Analytics source.

​
SetGaSource(String)

Sets the Google Analytics source for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetGaCampaign()

Gets the Google Analytics campaign for the EmailFlow.
Returns: CRMScript.Global.String - Google Analytics campaign.

​
SetGaCampaign(String)

Sets the Google Analytics campaign for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetUseTimeframe()

Gets whether to use sender timeframe settings.
Returns: CRMScript.Global.Bool - True if using timeframe settings.

​
SetUseTimeframe(Bool)

Sets whether to use sender timeframe settings.
Returns: CRMScript.Global.Void

​
GetSelectedDays()

Gets the selected days for the sender timeframe.
Returns: CRMScript.NetServer.Weekday - Selected days.

​
SetSelectedDays(Weekday)

Sets the selected days for the sender timeframe.
Returns: CRMScript.Global.Void

​
GetTimeframeStart()

Gets the start time for the sender timeframe.
Returns: CRMScript.Global.String - Start time.

​
SetTimeframeStart(String)

Sets the start time for the sender timeframe.
Returns: CRMScript.Global.Void

​
GetTimeframeEnd()

Gets the end time for the sender timeframe.
Returns: CRMScript.Global.String - End time.

​
SetTimeframeEnd(String)

Sets the end time for the sender timeframe.
Returns: CRMScript.Global.Void

​
GetUseWorkflowStart()

Gets whether to use workflow start settings.
Returns: CRMScript.Global.Bool - True if using workflow start settings.

​
SetUseWorkflowStart(Bool)

Sets whether to use workflow start settings.
Returns: CRMScript.Global.Void

​
GetWorkflowStart()

Gets the workflow start settings.
Returns: CRMScript.Global.String - Workflow start settings.

​
SetWorkflowStart(String)

Sets the workflow start settings.
Returns: CRMScript.Global.Void

​
GetUseEnrollmentEnd()

Gets whether to use enrollment end settings.
Returns: CRMScript.Global.Bool - True if using enrollment end settings.

​
SetUseEnrollmentEnd(Bool)

Sets whether to use enrollment end settings.
Returns: CRMScript.Global.Void

​
GetEnrollmentEnd()

Gets the enrollment end settings.
Returns: CRMScript.Global.String - Enrollment end settings.

​
SetEnrollmentEnd(String)

Sets the enrollment end settings.
Returns: CRMScript.Global.Void

​
GetRemoveFromFlows()

Gets the flows to remove the sender from.
Returns: CRMScript.Native.Vector - Flows to remove from.

​
SetRemoveFromFlows(Vector)

Sets the flows to remove the sender from.
Returns: CRMScript.Global.Void

​
GetTzLocation()

Gets the workflow timezone setting.
Returns: CRMScript.NetServer.NSTimeZoneData - Timezone data.

​
GetFolder()

Gets the folder setting for the EmailFlow.
Returns: CRMScript.NetServer.NSHierarchyEntity - Folder entity.

​
SetFolder(NSHierarchyEntity)

Sets the folder setting for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetAssociate()

Gets the associate setting for the EmailFlow.
Returns: CRMScript.NetServer.NSAssociate - Associate entity.

​
SetAssociate(NSAssociate)

Sets the associate setting for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetShipmentType()

Gets the shipment type setting for the EmailFlow.
Returns: CRMScript.NetServer.NSMDOListItem - Shipment type item.

​
SetShipmentType(NSMDOListItem)

Sets the shipment type setting for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetSteps()

Gets the workflow steps for the EmailFlow.
Returns: CRMScript.Native.Vector - Vector of workflow steps.

​
SetSteps(Vector)

Sets the workflow steps for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetTriggers()

Gets the triggers for the EmailFlow.
Returns: CRMScript.Native.Vector - Vector of triggers.

​
SetTriggers(Vector)

Sets the triggers for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetGoals()

Gets the goals for the EmailFlow.
Returns: CRMScript.Native.Vector - Vector of goals.

​
SetGoals(Vector)

Sets the goals for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetFilter()

Gets the filter for the EmailFlow.
Returns: CRMScript.NetServer.NSWorkflowFilter - Workflow filter.

​
SetFilter(NSWorkflowFilter)

Sets the filter for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetBlockLists()

Gets the block lists for the EmailFlow.
Returns: CRMScript.Native.Vector - Vector of block lists.

​
SetBlockLists(Vector)

Sets the block lists for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetContentInfo()

Gets the content information for the EmailFlow.
Returns: CRMScript.NetServer.NSContentInfo - Content information.

​
GetExitFlowId()

Gets the exit flow ID for the EmailFlow.
Returns: CRMScript.Global.Integer - Exit flow ID.

​
SetExitFlowId(Integer)

Sets the exit flow ID for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetExitSuccessFlowId()

Gets the exit success flow ID for the EmailFlow.
Returns: CRMScript.Global.Integer - Exit success flow ID.

​
SetExitSuccessFlowId(Integer)

Sets the exit success flow ID for the EmailFlow.
Returns: CRMScript.Global.Void

​
GetCreatedBy()

Gets the associate that first created the EmailFlow. Read-only property.
Returns: CRMScript.NetServer.NSAssociate - The associate who created the flow.

​
GetUpdatedBy()

Gets the associate that last updated the EmailFlow. Read-only property.
Returns: CRMScript.NetServer.NSAssociate - The associate who last updated the flow.

​
SetUpdatedBy(NSAssociate)

Sets the associate that last updated the EmailFlow. Read-only property.
Returns: CRMScript.Global.Void

​
GetCreatedDate()

Gets the date and time when the EmailFlow was created. Read-only property.
Returns: CRMScript.Global.DateTime - The creation date and time.

​
GetUpdatedDate()

Gets the date and time when the EmailFlow was last updated. Read-only property.
Returns: CRMScript.Global.DateTime - The last updated date and time.

​
GetDescription()

Gets the description of the workflow.
Returns: CRMScript.Global.String - The description of the workflow.

​
GetJumpToFinish()

Gets whether a contact jumps directly to finished when a goal is reached.
Returns: CRMScript.Global.Bool - True if the contact jumps directly to finished when a goal is reached.

​
GetName()

Gets the name of the workflow.
Returns: CRMScript.Global.String - The name of the workflow.

​
GetStatus()

Gets the status of the workflow definition.
Returns: CRMScript.NetServer.WorkflowDefinitionStatus - The status of the workflow definition.

​
SetDescription(String)

Sets the description of the workflow.
Returns: CRMScript.Global.Void

​
SetJumpToFinish(Bool)

Sets whether a contact jumps directly to finished when a goal is reached.
Returns: CRMScript.Global.Void

​
SetName(String)

Sets the name of the workflow.
Returns: CRMScript.Global.Void

​
SetStatus(WorkflowDefinitionStatus)

Sets the status of the workflow definition.
Returns: CRMScript.Global.Void

​
SetTzLocation(NSTimeZoneData)

Sets the workflow timezone setting.
Returns: CRMScript.Global.Void

Related topics

NSWorkflowAgentNamespace CRMScript.NetServerSave email flowEmailFlowsDelete Email FlowSave Email Flow