> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.EmailFlow

# <a id="SuperOffice_WebApi_Data_EmailFlow" /> Class EmailFlow

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for EmailFlow.
Email flow carrier

```csharp theme={null}
public class EmailFlow : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get EmailFlow 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new WorkflowAgent(configuration);
var emailFlow = agent.GetEmailFlow( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_EmailFlow__ctor" /> EmailFlow()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public EmailFlow()
```

## Properties

### <a id="SuperOffice_WebApi_Data_EmailFlow_Associate" /> Associate

The owner of the workflow.
<p>Use MDO List name "associate" to get list items.</p>

```csharp theme={null}
public virtual Associate Associate { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_BlockLists" /> BlockLists

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

```csharp theme={null}
public virtual int[] BlockLists { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_ContentInfo" /> ContentInfo

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

```csharp theme={null}
public virtual WorkflowContentInfo[] ContentInfo { get; set; }
```

#### Property Value

[WorkflowContentInfo](SuperOffice.WebApi.Data.WorkflowContentInfo.md)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_CreatedBy" /> CreatedBy

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

```csharp theme={null}
public virtual Associate CreatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_CreatedDate" /> CreatedDate

Registered date

```csharp theme={null}
public virtual DateTime CreatedDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Description" /> Description

Description of the workflow

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_EmailFlowId" /> EmailFlowId

Primary key

```csharp theme={null}
public virtual int EmailFlowId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_EmailFlow_EnrollmentEnd" /> EnrollmentEnd

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

```csharp theme={null}
public virtual string EnrollmentEnd { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ExitFlowId" /> ExitFlowId

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

```csharp theme={null}
public virtual int ExitFlowId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ExitSuccessFlowId" /> ExitSuccessFlowId

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

```csharp theme={null}
public virtual int ExitSuccessFlowId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Filter" /> Filter

The filter for the workflow.

```csharp theme={null}
public virtual WorkflowFilter Filter { get; set; }
```

#### Property Value

[WorkflowFilter](SuperOffice.WebApi.Data.WorkflowFilter.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Folder" /> Folder

The folder/hierarchy the email flow is in.
<p>Use MDO List name "hierarchy" to get list items.</p>

```csharp theme={null}
public virtual HierarchyEntity Folder { get; set; }
```

#### Property Value

[HierarchyEntity](SuperOffice.WebApi.Data.HierarchyEntity.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_FromAddr" /> FromAddr

Email From address: [name@domain.com](mailto:name@domain.com)

```csharp theme={null}
public virtual string FromAddr { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_FromName" /> FromName

Email From name

```csharp theme={null}
public virtual string FromName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_FromType" /> FromType

Email/Mailing From field address algorithm
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public EmailFromType? FromType { get; set; }
```

#### Property Value

[EmailFromType](SuperOffice.WebApi.Data.EmailFromType.md)?

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[FromType\_String](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_FromType_String)

### <a id="SuperOffice_WebApi_Data_EmailFlow_FromType_String" /> FromType\_String

Email/Mailing From field address algorithm
Raw string enum value.

```csharp theme={null}
[JsonProperty("FromType")]
public string FromType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[FromType](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_FromType)

### <a id="SuperOffice_WebApi_Data_EmailFlow_GaCampaign" /> GaCampaign

GA Campaign

```csharp theme={null}
public virtual string GaCampaign { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_GaSource" /> GaSource

GA Source

```csharp theme={null}
public virtual string GaSource { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Goals" /> Goals

The goals for the workflow.

```csharp theme={null}
public virtual WorkflowGoal[] Goals { get; set; }
```

#### Property Value

[WorkflowGoal](SuperOffice.WebApi.Data.WorkflowGoal.md)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_JumpToFinish" /> JumpToFinish

When a goal is reached, contact jumps directly to finished

```csharp theme={null}
public virtual bool JumpToFinish { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Name" /> Name

Name of the workflow

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_OverrideConsentSubscription" /> OverrideConsentSubscription

Override consent and subscription

```csharp theme={null}
public virtual bool OverrideConsentSubscription { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_RemoveFromFlows" /> RemoveFromFlows

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

```csharp theme={null}
public virtual int[] RemoveFromFlows { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_ReplyToAddr" /> ReplyToAddr

Reply to address, if different from From-address

```csharp theme={null}
public virtual string ReplyToAddr { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ReplyToName" /> ReplyToName

Email Reply-To name

```csharp theme={null}
public virtual string ReplyToName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ReplyToType" /> ReplyToType

Email/Mailing Reply-To field address algorithm
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public EmailReplyToType? ReplyToType { get; set; }
```

#### Property Value

[EmailReplyToType](SuperOffice.WebApi.Data.EmailReplyToType.md)?

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[ReplyToType\_String](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_ReplyToType_String)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ReplyToType_String" /> ReplyToType\_String

Email/Mailing Reply-To field address algorithm
Raw string enum value.

```csharp theme={null}
[JsonProperty("ReplyToType")]
public string ReplyToType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[ReplyToType](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_ReplyToType)

### <a id="SuperOffice_WebApi_Data_EmailFlow_SelectedDays" /> SelectedDays

Selected days (flags, so several days can be selected) for time frame
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public Weekday? SelectedDays { get; set; }
```

#### Property Value

[Weekday](SuperOffice.WebApi.Data.Weekday.md)?

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[SelectedDays\_String](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_SelectedDays_String)

### <a id="SuperOffice_WebApi_Data_EmailFlow_SelectedDays_String" /> SelectedDays\_String

Selected days (flags, so several days can be selected) for time frame
Raw string enum value.

```csharp theme={null}
[JsonProperty("SelectedDays")]
public string SelectedDays_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[SelectedDays](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_SelectedDays)

### <a id="SuperOffice_WebApi_Data_EmailFlow_ShipmentType" /> ShipmentType

The Shipment type (mailing type)

```csharp theme={null}
public virtual MDOListItem ShipmentType { get; set; }
```

#### Property Value

[MDOListItem](SuperOffice.WebApi.Data.MDOListItem.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_SmsSender" /> SmsSender

SMS sender (number or name)

```csharp theme={null}
public virtual string SmsSender { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_StartOnlyOnce" /> StartOnlyOnce

A contact can start this flow only once

```csharp theme={null}
public virtual bool StartOnlyOnce { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Status" /> Status

Status of the workflow definition
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public WorkflowDefinitionStatus? Status { get; set; }
```

#### Property Value

[WorkflowDefinitionStatus](SuperOffice.WebApi.Data.WorkflowDefinitionStatus.md)?

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[Status\_String](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_Status_String)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Status_String" /> Status\_String

Status of the workflow definition
Raw string enum value.

```csharp theme={null}
[JsonProperty("Status")]
public string Status_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[EmailFlow](SuperOffice.WebApi.Data.EmailFlow.md).[Status](SuperOffice.WebApi.Data.EmailFlow.md#SuperOffice_WebApi_Data_EmailFlow_Status)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Steps" /> Steps

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

```csharp theme={null}
public virtual WorkflowStepBase[] Steps { get; set; }
```

#### Property Value

[WorkflowStepBase](SuperOffice.WebApi.Data.WorkflowStepBase.md)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_TimeframeEnd" /> TimeframeEnd

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

```csharp theme={null}
public virtual string TimeframeEnd { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_TimeframeStart" /> TimeframeStart

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

```csharp theme={null}
public virtual string TimeframeStart { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_EmailFlow_Triggers" /> Triggers

The triggers for the workflow.

```csharp theme={null}
public virtual WorkflowTrigger[] Triggers { get; set; }
```

#### Property Value

[WorkflowTrigger](SuperOffice.WebApi.Data.WorkflowTrigger.md)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_TzLocation" /> TzLocation

The workflow timezone setting

```csharp theme={null}
public virtual TimeZoneData TzLocation { get; set; }
```

#### Property Value

[TimeZoneData](SuperOffice.WebApi.Data.TimeZoneData.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UpdatedBy" /> UpdatedBy

The person that last updated the flow.

```csharp theme={null}
public virtual Associate UpdatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UpdatedDate" /> UpdatedDate

Updated date

```csharp theme={null}
public virtual DateTime UpdatedDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UseEnrollmentEnd" /> UseEnrollmentEnd

End enrollment into the workflow at the given time

```csharp theme={null}
public virtual bool UseEnrollmentEnd { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UseGoogleAnalytics" /> UseGoogleAnalytics

Use Google Analytics

```csharp theme={null}
public virtual bool UseGoogleAnalytics { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UseTimeframe" /> UseTimeframe

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

```csharp theme={null}
public virtual bool UseTimeframe { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_UseWorkflowStart" /> UseWorkflowStart

Start the flow running with enrolled participants at the given time

```csharp theme={null}
public virtual bool UseWorkflowStart { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_EmailFlow_VisibleFor" /> VisibleFor

The set of users or groups the record is visible for

```csharp theme={null}
public virtual VisibleFor[] VisibleFor { get; set; }
```

#### Property Value

[VisibleFor](SuperOffice.WebApi.Data.VisibleFor.md)\[]

### <a id="SuperOffice_WebApi_Data_EmailFlow_WorkflowStart" /> 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

```csharp theme={null}
public virtual string WorkflowStart { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

## See Also

[WorkflowAgent](SuperOffice.WebApi.Agents.WorkflowAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.FormEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.FormEntity.md)
- [SuperOffice.WebApi.Agents.IWorkflowAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IWorkflowAgent.md)
- [SuperOffice.WebApi.Agents.WorkflowAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.WorkflowAgent.md)
- [SuperOffice.WebApi.Data.Domain](/en/api/reference/webapi/SuperOffice.WebApi.Data.Domain.md)
- [EmailFlows](/en/api/archive-providers/reference/emailflows.md)
- [emailflow](/en/api/mdo-providers/reference/emailflow.md)