Class EmailFlow

Email flow carrier

Carrier object for EmailFlow. Services for the EmailFlow Carrier is available from the Workflow Agent.
Inheritance
object
EmailFlow
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class EmailFlow : Carrier, IVisibleForCarrier
Examples

Get EmailFlow 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new WorkflowAgent();
   var emailFlow = agent.GetEmailFlow( 123 );
}

Constructors

EmailFlow()

Default constructor

Declaration
public EmailFlow()
See Also

Properties

Associate

The owner of the workflow.

Use MDO List name "associate" to get list items.

Declaration
[DataMember]
public virtual Associate Associate { get; set; }
Property Value
Type Description
Associate
See Also

BlockLists

Persons in the given selections are not allowed to enter this workflow

Declaration
[DataMember]
public virtual int[] BlockLists { get; set; }
Property Value
Type Description
int[]
See Also

ContentInfo

Info about workflow content like messages, links and forms (read-only)

Declaration
[DataMember]
public virtual WorkflowContentInfo[] ContentInfo { get; set; }
Property Value
Type Description
WorkflowContentInfo[]
See Also

CreatedBy

The associate that first created the flow. The property is read-only.

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also

CreatedDate

Registered date in UTC.

Declaration
[DataMember]
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

Description

Description of the workflow

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

EmailFlowId

Primary key

Declaration
[DataMember]
public virtual int EmailFlowId { get; set; }
Property Value
Type Description
int
See Also

EnrollmentEnd

Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone

Declaration
[DataMember]
public virtual string EnrollmentEnd { get; set; }
Property Value
Type Description
string
See Also

ExitFlowId

On exit with no success criteria met, we attempt to add the participant to the given flow

Declaration
[DataMember]
public virtual int ExitFlowId { get; set; }
Property Value
Type Description
int
See Also

ExitSuccessFlowId

On exit with success criteria met, we attempt to add the participant to the given flow

Declaration
[DataMember]
public virtual int ExitSuccessFlowId { get; set; }
Property Value
Type Description
int
See Also

Filter

The filter for the workflow.

Declaration
[DataMember]
public virtual WorkflowFilter Filter { get; set; }
Property Value
Type Description
WorkflowFilter
See Also

Folder

The folder/hierarchy the email flow is in.

Use MDO List name "hierarchy" to get list items.

Declaration
[DataMember]
public virtual HierarchyEntity Folder { get; set; }
Property Value
Type Description
HierarchyEntity
See Also

FromAddr

Email From address: name@domain.com

Declaration
[DataMember]
public virtual string FromAddr { get; set; }
Property Value
Type Description
string
See Also

FromName

Email From name

Declaration
[DataMember]
public virtual string FromName { get; set; }
Property Value
Type Description
string
See Also

FromType

Email/Mailing From field address algorithm

Declaration
[DataMember]
public virtual EmailFromType FromType { get; set; }
Property Value
Type Description
EmailFromType
See Also

GaCampaign

GA Campaign

Declaration
[DataMember]
public virtual string GaCampaign { get; set; }
Property Value
Type Description
string
See Also

GaSource

GA Source

Declaration
[DataMember]
public virtual string GaSource { get; set; }
Property Value
Type Description
string
See Also

Goals

The goals for the workflow.

Declaration
[DataMember]
public virtual WorkflowGoal[] Goals { get; set; }
Property Value
Type Description
WorkflowGoal[]
See Also

JumpToFinish

When a goal is reached, contact jumps directly to finished

Declaration
[DataMember]
public virtual bool JumpToFinish { get; set; }
Property Value
Type Description
bool
See Also

Name

Name of the workflow

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

OverrideConsentSubscription

Override consent and subscription

Declaration
[DataMember]
public virtual bool OverrideConsentSubscription { get; set; }
Property Value
Type Description
bool
See Also

RemoveFromFlows

Workflows to remove the participants from when they are enrolled in this workflow

Declaration
[DataMember]
public virtual int[] RemoveFromFlows { get; set; }
Property Value
Type Description
int[]
See Also

ReplyToAddr

Reply to address, if different from From-address

Declaration
[DataMember]
public virtual string ReplyToAddr { get; set; }
Property Value
Type Description
string
See Also

ReplyToName

Email Reply-To name

Declaration
[DataMember]
public virtual string ReplyToName { get; set; }
Property Value
Type Description
string
See Also

ReplyToType

Email/Mailing Reply-To field address algorithm

Declaration
[DataMember]
public virtual EmailReplyToType ReplyToType { get; set; }
Property Value
Type Description
EmailReplyToType
See Also

SelectedDays

Selected days (flags, so several days can be selected) for time frame

Declaration
[DataMember]
public virtual Weekday SelectedDays { get; set; }
Property Value
Type Description
Weekday
See Also

ShipmentType

The Shipment type (mailing type)

Declaration
[DataMember]
public virtual MDOListItem ShipmentType { get; set; }
Property Value
Type Description
MDOListItem
See Also

SmsSender

SMS sender (number or name)

Declaration
[DataMember]
public virtual string SmsSender { get; set; }
Property Value
Type Description
string
See Also

StartOnlyOnce

A contact can start this flow only once

Declaration
[DataMember]
public virtual bool StartOnlyOnce { get; set; }
Property Value
Type Description
bool
See Also

Status

Status of the workflow definition

Declaration
[DataMember]
public virtual WorkflowDefinitionStatus Status { get; set; }
Property Value
Type Description
WorkflowDefinitionStatus
See Also

Steps

The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.

Declaration
[DataMember]
public virtual WorkflowStepBase[] Steps { get; set; }
Property Value
Type Description
WorkflowStepBase[]
See Also

TimeframeEnd

End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

Declaration
[DataMember]
public virtual string TimeframeEnd { get; set; }
Property Value
Type Description
string
See Also

TimeframeStart

Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

Declaration
[DataMember]
public virtual string TimeframeStart { get; set; }
Property Value
Type Description
string
See Also

Triggers

The triggers for the workflow.

Declaration
[DataMember]
public virtual WorkflowTrigger[] Triggers { get; set; }
Property Value
Type Description
WorkflowTrigger[]
See Also

TzLocation

The workflow timezone setting

Declaration
[DataMember]
public virtual TimeZoneData TzLocation { get; set; }
Property Value
Type Description
TimeZoneData
See Also

UpdatedBy

The person that last updated the flow.

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also

UpdatedDate

Updated date in UTC.

Declaration
[DataMember]
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

UseEnrollmentEnd

End enrollment into the workflow at the given time

Declaration
[DataMember]
public virtual bool UseEnrollmentEnd { get; set; }
Property Value
Type Description
bool
See Also

UseGoogleAnalytics

Use Google Analytics

Declaration
[DataMember]
public virtual bool UseGoogleAnalytics { get; set; }
Property Value
Type Description
bool
See Also

UseTimeframe

Use sender timeframe settings, only send email/sms within the timeframe

Declaration
[DataMember]
public virtual bool UseTimeframe { get; set; }
Property Value
Type Description
bool
See Also

UseWorkflowStart

Start the flow running with enrolled participants at the given time

Declaration
[DataMember]
public virtual bool UseWorkflowStart { get; set; }
Property Value
Type Description
bool
See Also

VisibleFor

The set of users or groups the record is visible for

Declaration
[DataMember]
public VisibleFor[] VisibleFor { get; set; }
Property Value
Type Description
VisibleFor[]
See Also

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

Declaration
[DataMember]
public virtual string WorkflowStart { get; set; }
Property Value
Type Description
string
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

Implements

See Also