Class NSEmailFlow
Carrier object for EmailFlow.
Constructors
NSEmailFlow()
Initializes a new instance of the NSEmailFlow class.
Declaration
NSEmailFlowMethods
GetEmailFlowId()
Gets the primary key (ID) for the EmailFlow.
Declaration
Integer GetEmailFlowId()Returns
| Type | Description |
| Integer | EmailFlow Id. |
SetEmailFlowId(Integer)
Sets the primary key (ID) for the EmailFlow.
Declaration
Void SetEmailFlowId(Integer emailFlowId)Parameters
| Type | Name | Description |
| Integer | emailFlowId | The EmailFlow ID to set. |
Returns
| Type | Description |
| Void |
GetStartOnlyOnce()
Gets whether a contact can start this flow only once.
Declaration
Bool GetStartOnlyOnce()Returns
| Type | Description |
| Bool | True if contact can only start once. |
SetStartOnlyOnce(Bool)
Sets whether a contact can start this flow only once.
Declaration
Void SetStartOnlyOnce(Bool startOnlyOnce)Parameters
| Type | Name | Description |
| Bool | startOnlyOnce | True if contact can only start once. |
Returns
| Type | Description |
| Void |
GetOverrideConsentSubscription()
Gets whether to override consent subscription.
Declaration
Bool GetOverrideConsentSubscription()Returns
| Type | Description |
| Bool | True to override consent subscription. |
SetOverrideConsentSubscription(Bool)
Sets whether to override consent subscription.
Declaration
Void SetOverrideConsentSubscription(Bool overrideConsentSubscription)Parameters
| Type | Name | Description |
| Bool | overrideConsentSubscription | True to override consent subscription. |
Returns
| Type | Description |
| Void |
GetFromType()
Gets the type of sender for the EmailFlow.
Declaration
EmailFromType GetFromType()Returns
| Type | Description |
| EmailFromType | Sender type. |
SetFromType(EmailFromType)
Sets the type of sender for the EmailFlow.
Declaration
Void SetFromType(EmailFromType fromType)Parameters
| Type | Name | Description |
| EmailFromType | fromType | The sender type to set. |
Returns
| Type | Description |
| Void |
GetFromName()
Gets the name of the sender for the EmailFlow.
Declaration
String GetFromName()Returns
| Type | Description |
| String | Sender name. |
SetFromName(String)
Sets the name of the sender for the EmailFlow.
Declaration
Void SetFromName(String fromName)Parameters
| Type | Name | Description |
| String | fromName | The sender name to set. |
Returns
| Type | Description |
| Void |
GetFromAddr()
Gets the email address of the sender for the EmailFlow.
Declaration
String GetFromAddr()Returns
| Type | Description |
| String | Sender email address. |
SetFromAddr(String)
Sets the email address of the sender for the EmailFlow.
Declaration
Void SetFromAddr(String fromAddr)Parameters
| Type | Name | Description |
| String | fromAddr | The sender email address to set. |
Returns
| Type | Description |
| Void |
GetReplyToType()
Gets the reply-to type for the EmailFlow.
Declaration
EmailReplyToType GetReplyToType()Returns
| Type | Description |
| EmailReplyToType | Reply-to type. |
SetReplyToType(EmailReplyToType)
Sets the reply-to type for the EmailFlow.
Declaration
Void SetReplyToType(EmailReplyToType replyToType)Parameters
| Type | Name | Description |
| EmailReplyToType | replyToType | The reply-to type to set. |
Returns
| Type | Description |
| Void |
GetReplyToAddr()
Gets the reply-to email address for the EmailFlow.
Declaration
String GetReplyToAddr()Returns
| Type | Description |
| String | Reply-to email address. |
SetReplyToAddr(String)
Sets the reply-to email address for the EmailFlow.
Declaration
Void SetReplyToAddr(String replyToAddr)Parameters
| Type | Name | Description |
| String | replyToAddr | The reply-to email address to set. |
Returns
| Type | Description |
| Void |
GetReplyToName()
Gets the name for the reply-to address in the EmailFlow.
Declaration
String GetReplyToName()Returns
| Type | Description |
| String | Reply-to name. |
SetReplyToName(String)
Sets the name for the reply-to address in the EmailFlow.
Declaration
Void SetReplyToName(String replyToName)Parameters
| Type | Name | Description |
| String | replyToName | The reply-to name to set. |
Returns
| Type | Description |
| Void |
GetSmsSender()
Gets the SMS sender information for the EmailFlow.
Declaration
String GetSmsSender()Returns
| Type | Description |
| String | SMS sender information. |
SetSmsSender(String)
Sets the SMS sender information for the EmailFlow.
Declaration
Void SetSmsSender(String smsSender)Parameters
| Type | Name | Description |
| String | smsSender | The SMS sender information to set. |
Returns
| Type | Description |
| Void |
GetUseGoogleAnalytics()
Gets whether to use Google Analytics for the EmailFlow.
Declaration
Bool GetUseGoogleAnalytics()Returns
| Type | Description |
| Bool | True to use Google Analytics. |
SetUseGoogleAnalytics(Bool)
Sets whether to use Google Analytics for the EmailFlow.
Declaration
Void SetUseGoogleAnalytics(Bool useGoogleAnalytics)Parameters
| Type | Name | Description |
| Bool | useGoogleAnalytics | True to use Google Analytics. |
Returns
| Type | Description |
| Void |
GetGaSource()
Gets the Google Analytics source for the EmailFlow.
Declaration
String GetGaSource()Returns
| Type | Description |
| String | Google Analytics source. |
SetGaSource(String)
Sets the Google Analytics source for the EmailFlow.
Declaration
Void SetGaSource(String gaSource)Parameters
| Type | Name | Description |
| String | gaSource | The Google Analytics source to set. |
Returns
| Type | Description |
| Void |
GetGaCampaign()
Gets the Google Analytics campaign for the EmailFlow.
Declaration
String GetGaCampaign()Returns
| Type | Description |
| String | Google Analytics campaign. |
SetGaCampaign(String)
Sets the Google Analytics campaign for the EmailFlow.
Declaration
Void SetGaCampaign(String gaCampaign)Parameters
| Type | Name | Description |
| String | gaCampaign | The Google Analytics campaign to set. |
Returns
| Type | Description |
| Void |
GetUseTimeframe()
Gets whether to use sender timeframe settings.
Declaration
Bool GetUseTimeframe()Returns
| Type | Description |
| Bool | True if using timeframe settings. |
SetUseTimeframe(Bool)
Sets whether to use sender timeframe settings.
Declaration
Void SetUseTimeframe(Bool useTimeframe)Parameters
| Type | Name | Description |
| Bool | useTimeframe | True to use sender timeframe settings. |
Returns
| Type | Description |
| Void |
GetSelectedDays()
Gets the selected days for the sender timeframe.
Declaration
Weekday GetSelectedDays()Returns
| Type | Description |
| Weekday | Selected days. |
SetSelectedDays(Weekday)
Sets the selected days for the sender timeframe.
Declaration
Void SetSelectedDays(Weekday selectedDays)Parameters
| Type | Name | Description |
| Weekday | selectedDays | The selected days to set. |
Returns
| Type | Description |
| Void |
GetTimeframeStart()
Gets the start time for the sender timeframe.
Declaration
String GetTimeframeStart()Returns
| Type | Description |
| String | Start time. |
SetTimeframeStart(String)
Sets the start time for the sender timeframe.
Declaration
Void SetTimeframeStart(String timeframeStart)Parameters
| Type | Name | Description |
| String | timeframeStart | The start time to set. |
Returns
| Type | Description |
| Void |
GetTimeframeEnd()
Gets the end time for the sender timeframe.
Declaration
String GetTimeframeEnd()Returns
| Type | Description |
| String | End time. |
SetTimeframeEnd(String)
Sets the end time for the sender timeframe.
Declaration
Void SetTimeframeEnd(String timeframeEnd)Parameters
| Type | Name | Description |
| String | timeframeEnd | The end time to set. |
Returns
| Type | Description |
| Void |
GetUseWorkflowStart()
Gets whether to use workflow start settings.
Declaration
Bool GetUseWorkflowStart()Returns
| Type | Description |
| Bool | True if using workflow start settings. |
SetUseWorkflowStart(Bool)
Sets whether to use workflow start settings.
Declaration
Void SetUseWorkflowStart(Bool useWorkflowStart)Parameters
| Type | Name | Description |
| Bool | useWorkflowStart | True to use workflow start settings. |
Returns
| Type | Description |
| Void |
GetWorkflowStart()
Gets the workflow start settings.
Declaration
String GetWorkflowStart()Returns
| Type | Description |
| String | Workflow start settings. |
SetWorkflowStart(String)
Sets the workflow start settings.
Declaration
Void SetWorkflowStart(String workflowStart)Parameters
| Type | Name | Description |
| String | workflowStart | The workflow start settings to set. |
Returns
| Type | Description |
| Void |
GetUseEnrollmentEnd()
Gets whether to use enrollment end settings.
Declaration
Bool GetUseEnrollmentEnd()Returns
| Type | Description |
| Bool | True if using enrollment end settings. |
SetUseEnrollmentEnd(Bool)
Sets whether to use enrollment end settings.
Declaration
Void SetUseEnrollmentEnd(Bool useEnrollmentEnd)Parameters
| Type | Name | Description |
| Bool | useEnrollmentEnd | True to use enrollment end settings. |
Returns
| Type | Description |
| Void |
GetEnrollmentEnd()
Gets the enrollment end settings.
Declaration
String GetEnrollmentEnd()Returns
| Type | Description |
| String | Enrollment end settings. |
SetEnrollmentEnd(String)
Sets the enrollment end settings.
Declaration
Void SetEnrollmentEnd(String enrollmentEnd)Parameters
| Type | Name | Description |
| String | enrollmentEnd | The enrollment end settings to set. |
Returns
| Type | Description |
| Void |
GetRemoveFromFlows()
Gets the flows to remove the sender from.
Declaration
Vector GetRemoveFromFlows()Returns
| Type | Description |
| Vector | Flows to remove from. |
SetRemoveFromFlows(Vector)
Sets the flows to remove the sender from.
Declaration
Void SetRemoveFromFlows(Vector removeFromFlows)Parameters
| Type | Name | Description |
| Vector | removeFromFlows | The flows to remove from. |
Returns
| Type | Description |
| Void |
GetTzLocation()
Gets the workflow timezone setting.
Declaration
NSTimeZoneData GetTzLocation()Returns
| Type | Description |
| NSTimeZoneData | Timezone data. |
GetFolder()
Gets the folder setting for the EmailFlow.
Declaration
NSHierarchyEntity GetFolder()Returns
| Type | Description |
| NSHierarchyEntity | Folder entity. |
SetFolder(NSHierarchyEntity)
Sets the folder setting for the EmailFlow.
Declaration
Void SetFolder(NSHierarchyEntity folder)Parameters
| Type | Name | Description |
| NSHierarchyEntity | folder | The folder entity to set. |
Returns
| Type | Description |
| Void |
GetAssociate()
Gets the associate setting for the EmailFlow.
Declaration
NSAssociate GetAssociate()Returns
| Type | Description |
| NSAssociate | Associate entity. |
SetAssociate(NSAssociate)
Sets the associate setting for the EmailFlow.
Declaration
Void SetAssociate(NSAssociate associate)Parameters
| Type | Name | Description |
| NSAssociate | associate | The associate entity to set. |
Returns
| Type | Description |
| Void |
GetShipmentType()
Gets the shipment type setting for the EmailFlow.
Declaration
NSMDOListItem GetShipmentType()Returns
| Type | Description |
| NSMDOListItem | Shipment type item. |
SetShipmentType(NSMDOListItem)
Sets the shipment type setting for the EmailFlow.
Declaration
Void SetShipmentType(NSMDOListItem shipmentType)Parameters
| Type | Name | Description |
| NSMDOListItem | shipmentType | The shipment type item to set. |
Returns
| Type | Description |
| Void |
GetSteps()
Gets the workflow steps for the EmailFlow.
Declaration
Vector GetSteps()Returns
| Type | Description |
| Vector | Vector of workflow steps. |
SetSteps(Vector)
Sets the workflow steps for the EmailFlow.
Declaration
Void SetSteps(Vector steps)Parameters
| Type | Name | Description |
| Vector | steps | The workflow steps to set. |
Returns
| Type | Description |
| Void |
GetTriggers()
Gets the triggers for the EmailFlow.
Declaration
Vector GetTriggers()Returns
| Type | Description |
| Vector | Vector of triggers. |
SetTriggers(Vector)
Sets the triggers for the EmailFlow.
Declaration
Void SetTriggers(Vector triggers)Parameters
| Type | Name | Description |
| Vector | triggers | The triggers to set. |
Returns
| Type | Description |
| Void |
GetGoals()
Gets the goals for the EmailFlow.
Declaration
Vector GetGoals()Returns
| Type | Description |
| Vector | Vector of goals. |
SetGoals(Vector)
Sets the goals for the EmailFlow.
Declaration
Void SetGoals(Vector goals)Parameters
| Type | Name | Description |
| Vector | goals | The goals to set. |
Returns
| Type | Description |
| Void |
GetFilter()
Gets the filter for the EmailFlow.
Declaration
NSWorkflowFilter GetFilter()Returns
| Type | Description |
| NSWorkflowFilter | Workflow filter. |
SetFilter(NSWorkflowFilter)
Sets the filter for the EmailFlow.
Declaration
Void SetFilter(NSWorkflowFilter filter)Parameters
| Type | Name | Description |
| NSWorkflowFilter | filter | The workflow filter to set. |
Returns
| Type | Description |
| Void |
GetBlockLists()
Gets the block lists for the EmailFlow.
Declaration
Vector GetBlockLists()Returns
| Type | Description |
| Vector | Vector of block lists. |
SetBlockLists(Vector)
Sets the block lists for the EmailFlow.
Declaration
Void SetBlockLists(Vector blockLists)Parameters
| Type | Name | Description |
| Vector | blockLists | The block lists to set. |
Returns
| Type | Description |
| Void |
GetContentInfo()
Gets the content information for the EmailFlow.
Declaration
NSContentInfo GetContentInfo()Returns
| Type | Description |
| Content information. |
GetExitFlowId()
Gets the exit flow ID for the EmailFlow.
Declaration
Integer GetExitFlowId()Returns
| Type | Description |
| Integer | Exit flow ID. |
SetExitFlowId(Integer)
Sets the exit flow ID for the EmailFlow.
Declaration
Void SetExitFlowId(Integer exitFlowId)Parameters
| Type | Name | Description |
| Integer | exitFlowId | The exit flow ID to set. |
Returns
| Type | Description |
| Void |
GetExitSuccessFlowId()
Gets the exit success flow ID for the EmailFlow.
Declaration
Integer GetExitSuccessFlowId()Returns
| Type | Description |
| Integer | Exit success flow ID. |
SetExitSuccessFlowId(Integer)
Sets the exit success flow ID for the EmailFlow.
Declaration
Void SetExitSuccessFlowId(Integer exitSuccessFlowId)Parameters
| Type | Name | Description |
| Integer | exitSuccessFlowId | The exit success flow ID to set. |
Returns
| Type | Description |
| Void |
GetCreatedBy()
Gets the associate that first created the EmailFlow. Read-only property.
Declaration
NSAssociate GetCreatedBy()Returns
| Type | Description |
| NSAssociate | The associate who created the flow. |
GetUpdatedBy()
Gets the associate that last updated the EmailFlow. Read-only property.
Declaration
NSAssociate GetUpdatedBy()Returns
| Type | Description |
| NSAssociate | The associate who last updated the flow. |
SetUpdatedBy(NSAssociate)
Sets the associate that last updated the EmailFlow. Read-only property.
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Parameters
| Type | Name | Description |
| NSAssociate | updatedBy | The associate who last updated the flow. |
Returns
| Type | Description |
| Void |
GetCreatedDate()
Gets the date and time when the EmailFlow was created. Read-only property.
Declaration
DateTime GetCreatedDate()Returns
| Type | Description |
| DateTime | The creation date and time. |
GetUpdatedDate()
Gets the date and time when the EmailFlow was last updated. Read-only property.
Declaration
DateTime GetUpdatedDate()Returns
| Type | Description |
| DateTime | The last updated date and time. |
GetDescription()
Gets the description of the workflow.
Declaration
String GetDescription()Returns
| Type | Description |
| String | The description of the workflow. |
GetJumpToFinish()
Gets whether a contact jumps directly to finished when a goal is reached.
Declaration
Bool GetJumpToFinish()Returns
| Type | Description |
| Bool | True if the contact jumps directly to finished when a goal is reached. |
GetName()
Gets the name of the workflow.
Declaration
String GetName()Returns
| Type | Description |
| String | The name of the workflow. |
GetStatus()
Gets the status of the workflow definition.
Declaration
WorkflowDefinitionStatus GetStatus()Returns
| Type | Description |
| WorkflowDefinitionStatus | The status of the workflow definition. |
SetDescription(String)
Sets the description of the workflow.
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
| String | description | The description of the workflow to set. |
Returns
| Type | Description |
| Void |
SetJumpToFinish(Bool)
Sets whether a contact jumps directly to finished when a goal is reached.
Declaration
Void SetJumpToFinish(Bool jumpToFinish)Parameters
| Type | Name | Description |
| Bool | jumpToFinish | True if the contact should jump directly to finished when a goal is reached. |
Returns
| Type | Description |
| Void |
SetName(String)
Sets the name of the workflow.
Declaration
Void SetName(String name)Parameters
| Type | Name | Description |
| String | name | The name of the workflow to set. |
Returns
| Type | Description |
| Void |
SetStatus(WorkflowDefinitionStatus)
Sets the status of the workflow definition.
Declaration
Void SetStatus(WorkflowDefinitionStatus status)Parameters
| Type | Name | Description |
| WorkflowDefinitionStatus | status | The status of the workflow definition to set. |
Returns
| Type | Description |
| Void |
SetTzLocation(NSTimeZoneData)
Sets the workflow timezone setting.
Declaration
Void SetTzLocation(NSTimeZoneData tzLocation)Parameters
| Type | Name | Description |
| NSTimeZoneData | tzLocation | The timezone setting to set. |
Returns
| Type | Description |
| Void |