Class EmailFlow
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for EmailFlow.
Email flow carrier
Inheritance
object ←
Carrier ←
EmailFlow
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get EmailFlow 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new WorkflowAgent(configuration);
var emailFlow = agent.GetEmailFlow( 123 );
Constructors
EmailFlow()
Default constructor - defaults any enum props to 0.
Properties
Associate
The owner of the workflow.
Use MDO List name “associate” to get list items.
Property Value
Associate
BlockLists
Persons in the given selections are not allowed to enter this workflow
Property Value
int[]
ContentInfo
Info about workflow content like messages, links and forms (read-only)
Property Value
WorkflowContentInfo[]
CreatedBy
The associate that first created the flow. The property is read-only.
Property Value
Associate
CreatedDate
Registered date
Property Value
DateTime
Description
Description of the workflow
Property Value
string
EmailFlowId
Primary key
Property Value
int
EnrollmentEnd
Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone
Property Value
string
ExitFlowId
On exit with no success criteria met, we attempt to add the participant to the given flow
Property Value
int
ExitSuccessFlowId
On exit with success criteria met, we attempt to add the participant to the given flow
Property Value
int
Filter
The filter for the workflow.
Property Value
WorkflowFilter
Folder
The folder/hierarchy the email flow is in.
Use MDO List name “hierarchy” to get list items.
Property Value
HierarchyEntity
FromAddr
Email From address: name@domain.com
Property Value
string
FromName
Email From name
Property Value
string
FromType
Email/Mailing From field address algorithm
NULL if unknown enum value.
Property Value
EmailFromType?
See Also
EmailFlow.FromType_String
FromType_String
Email/Mailing From field address algorithm
Raw string enum value.
Property Value
string
See Also
EmailFlow.FromType
GaCampaign
GA Campaign
Property Value
string
GaSource
GA Source
Property Value
string
Goals
The goals for the workflow.
Property Value
WorkflowGoal[]
JumpToFinish
When a goal is reached, contact jumps directly to finished
Property Value
bool
Name
Name of the workflow
Property Value
string
OverrideConsentSubscription
Override consent and subscription
Property Value
bool
RemoveFromFlows
Workflows to remove the participants from when they are enrolled in this workflow
Property Value
int[]
ReplyToAddr
Reply to address, if different from From-address
Property Value
string
ReplyToName
Email Reply-To name
Property Value
string
ReplyToType
Email/Mailing Reply-To field address algorithm
NULL if unknown enum value.
Property Value
EmailReplyToType?
See Also
EmailFlow.ReplyToType_String
ReplyToType_String
Email/Mailing Reply-To field address algorithm
Raw string enum value.
Property Value
string
See Also
EmailFlow.ReplyToType
SelectedDays
Selected days (flags, so several days can be selected) for time frame
NULL if unknown enum value.
Property Value
Weekday?
See Also
EmailFlow.SelectedDays_String
SelectedDays_String
Selected days (flags, so several days can be selected) for time frame
Raw string enum value.
Property Value
string
See Also
EmailFlow.SelectedDays
ShipmentType
The Shipment type (mailing type)
Property Value
MDOListItem
SmsSender
SMS sender (number or name)
Property Value
string
StartOnlyOnce
A contact can start this flow only once
Property Value
bool
Status
Status of the workflow definition
NULL if unknown enum value.
Property Value
WorkflowDefinitionStatus?
See Also
EmailFlow.Status_String
Status_String
Status of the workflow definition
Raw string enum value.
Property Value
string
See Also
EmailFlow.Status
Steps
The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.
Property Value
WorkflowStepBase[]
TimeframeEnd
End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone
Property Value
string
TimeframeStart
Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone
Property Value
string
Triggers
The triggers for the workflow.
Property Value
WorkflowTrigger[]
TzLocation
The workflow timezone setting
Property Value
TimeZoneData
UpdatedBy
The person that last updated the flow.
Property Value
Associate
UpdatedDate
Updated date
Property Value
DateTime
UseEnrollmentEnd
End enrollment into the workflow at the given time
Property Value
bool
UseGoogleAnalytics
Use Google Analytics
Property Value
bool
UseTimeframe
Use sender timeframe settings, only send email/sms within the timeframe
Property Value
bool
UseWorkflowStart
Start the flow running with enrolled participants at the given time
Property Value
bool
VisibleFor
The set of users or groups the record is visible for
Property Value
VisibleFor[]
WorkflowStart
When to start running the workflow. Until start, any enrolled members are not running through the flow, just waiting. In [DT: ] format, interpreted in workflow time zone
Property Value
string
See Also
WorkflowAgent
