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

# <a id="SuperOffice_WebApi_Data_PreviewMailingHeader" /> Class PreviewMailingHeader

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

Carrier object for PreviewMailingHeader.
A shipment with information intended for previewing it.

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

#### Inheritance

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

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_NumBounced" /> NumBounced

Number of recipients that resulted in a bounce.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailingHeader_NumClicks" /> NumClicks

Number of recipients that clicked at least 1 link in the mailing.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailingHeader_NumOpened" /> NumOpened

Number of recipients that opened the email.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailingHeader_NumSent" /> NumSent

Number of emails sent at the current time.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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_PreviewMailingHeader_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

[PreviewMailingHeader](SuperOffice.WebApi.Data.PreviewMailingHeader.md).[Status\_String](SuperOffice.WebApi.Data.PreviewMailingHeader.md#SuperOffice_WebApi_Data_PreviewMailingHeader_Status_String)

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

[PreviewMailingHeader](SuperOffice.WebApi.Data.PreviewMailingHeader.md).[Status](SuperOffice.WebApi.Data.PreviewMailingHeader.md#SuperOffice_WebApi_Data_PreviewMailingHeader_Status)

## See Also

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


## Related topics

- [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 GetPreviewMailingHeaderRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_GetPreviewMailingHeaderRequest.md)
- [SuperOffice.WebApi.Data.PreviewMailing](/en/api/reference/webapi/SuperOffice.WebApi.Data.PreviewMailing.md)
- [SuperOffice.WebApi.Data.Marketing GetPreviewMailingRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_GetPreviewMailingRequest.md)
- [NSPreviewMailingHeader](/en/automation/crmscript/reference/CRMScript.NetServer.NSPreviewMailingHeader.md)