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

# <a id="SuperOffice_WebApi_Data_PreviewMailing" /> Class PreviewMailing

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

Carrier object for PreviewMailing.
A shipment message with information about the recipient it was sent to.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[PreviewMailing](SuperOffice.WebApi.Data.PreviewMailing.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)

## Constructors

### <a id="SuperOffice_WebApi_Data_PreviewMailing__ctor" /> PreviewMailing()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_PreviewMailing_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_PreviewMailing_ContactId" /> ContactId

Owning contact ID

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_ContactName" /> ContactName

Contact name

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_DocumentMessageId" /> DocumentMessageId

If a document was used as the message this is the document ID.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_FromAddress" /> FromAddress

Email address to put in the From header of the messages

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_LinkClicks" /> LinkClicks

The number of links clicked in the mailing.

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

#### Property Value

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

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

Primary key

```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_PreviewMailing_MessageSubject" /> MessageSubject

The mail subject field of the message

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_Opened" /> Opened

Date/time the customer read the mailing.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_PersonFullName" /> PersonFullName

Get the persons full name (internal name used in clients for employees).

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_PersonId" /> PersonId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_SendingTime" /> SendingTime

Estimated or actual sent time (depends on status)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_ShipmentDescription" /> ShipmentDescription

Describes the shipment

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailing_ShipmentId" /> ShipmentId

Primary key

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

#### Property Value

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

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

The list item

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

#### Property Value

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

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

Status for sending to this particular recipient
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[PreviewMailing](SuperOffice.WebApi.Data.PreviewMailing.md).[Status\_String](SuperOffice.WebApi.Data.PreviewMailing.md#SuperOffice_WebApi_Data_PreviewMailing_Status_String)

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

Status for sending to this particular recipient
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

[PreviewMailing](SuperOffice.WebApi.Data.PreviewMailing.md).[Status](SuperOffice.WebApi.Data.PreviewMailing.md#SuperOffice_WebApi_Data_PreviewMailing_Status)

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.PreviewMailingHeader](/en/api/reference/webapi/SuperOffice.WebApi.Data.PreviewMailingHeader.md)
- [SuperOffice.WebApi.Agents.IMarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IMarketingAgent.md)
- [SuperOffice.WebApi.Agents.MarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.MarketingAgent.md)
- [SuperOffice.WebApi.Data.Marketing GetPreviewMailingRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_GetPreviewMailingRequest.md)
- [SuperOffice.WebApi.Data.Marketing GetPreviewMailingHeaderRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_GetPreviewMailingHeaderRequest.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)