> ## 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.MailingEntity

# <a id="SuperOffice_WebApi_Data_MailingEntity" /> Class MailingEntity

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

Carrier object for MailingEntity.
A mailing (shipment) — the run that sends a message to a set of recipients

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[MailingEntity](SuperOffice.WebApi.Data.MailingEntity.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 MailingEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var mailingEntity = agent.GetMailingEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_MailingEntity__ctor" /> MailingEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_MailingEntity_Configuration" /> Configuration

This field indicates what kind of shipment this is.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_DeliveredNum" /> DeliveredNum

Number of mails sent minus bounces

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

#### Property Value

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

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

Describes the shipment

```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_MailingEntity_EndDate" /> EndDate

Is set when this shipment is ended

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_EnvelopeFrom" /> EnvelopeFrom

Email address for the MTA envelope (where bounces are returned)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_FolderId" /> FolderId

The folder which this shipment belongs to. -1 indicates that the shipment is on the root

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

#### Property Value

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

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

Email address to put in the From header of the messages

```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_MailingEntity_MailingId" /> MailingId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_MessageId" /> MessageId

The id of the message that is sent in this shipment

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_ProjectId" /> ProjectId

Set if this shipment should be related to a Project

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_Recipients" /> Recipients

The total number of recipients to send message to.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_Registered" /> Registered

Registered when

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_RegisteredAssociateId" /> RegisteredAssociateId

Registered by whom

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_ReplyAddr" /> ReplyAddr

Email address to put in the Reply To: header of the messages

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_SelectionId" /> SelectionId

Set if this shipment should be related to a Selection

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_SentNum" /> SentNum

Number of mails sent

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_ShipmenttypeId" /> ShipmenttypeId

Id of subscriptionType that this shipment has, so we may check for reservations

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_StartDate" /> StartDate

The date and time when to start this shipment

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

#### Property Value

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

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

Sending/stopped/failed etc.
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[MailingEntity](SuperOffice.WebApi.Data.MailingEntity.md).[Status\_String](SuperOffice.WebApi.Data.MailingEntity.md#SuperOffice_WebApi_Data_MailingEntity_Status_String)

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

Sending/stopped/failed etc.
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

[MailingEntity](SuperOffice.WebApi.Data.MailingEntity.md).[Status](SuperOffice.WebApi.Data.MailingEntity.md#SuperOffice_WebApi_Data_MailingEntity_Status)

### <a id="SuperOffice_WebApi_Data_MailingEntity_Updated" /> Updated

Last updated when

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_UpdatedAssociateId" /> UpdatedAssociateId

Last updated by whom

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_MailingEntity_UpdatedCount" /> UpdatedCount

Number of updates made to this record

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

#### Property Value

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

## See Also

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


## Related topics

- [Agent API changes in 12.3](/release-notes/12/api/12.3.2570-update.md)
- [SuperOffice.WebApi.Data.SelectionEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.SelectionEntity.md)
- [SuperOffice.WebApi.Data.PersonEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.PersonEntity.md)
- [SuperOffice.WebApi.Data.PictureFolderEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.PictureFolderEntity.md)
- [SuperOffice.WebApi.Data.ShipmentMessageEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ShipmentMessageEntity.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)