Skip to main content

Class PreviewMailingHeader

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for PreviewMailingHeader. A shipment with information intended for previewing it.

Inheritance

objectCarrierPreviewMailingHeader

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

PreviewMailingHeader()

Default constructor - defaults any enum props to 0.

Properties

Configuration

This field indicates what kind of shipment this is.

Property Value

int

DocumentMessageId

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

Property Value

int

FromAddress

Email address to put in the From header of the messages

Property Value

string

MessageId

Primary key

Property Value

int

MessageSubject

The mail subject field of the message

Property Value

string

NumBounced

Number of recipients that resulted in a bounce.

Property Value

int

NumClicks

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

Property Value

int

NumOpened

Number of recipients that opened the email.

Property Value

int

NumSent

Number of emails sent at the current time.

Property Value

int

PersonFullName

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

Property Value

string

PersonId

Primary key

Property Value

int

ShipmentDescription

Describes the shipment

Property Value

string

ShipmentId

Primary key

Property Value

int

ShipmentType

The list item

Property Value

string

StartDate

The date and time when to start this shipment

Property Value

DateTime

Status

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

Property Value

ShipmentStatus?

See Also

PreviewMailingHeader.Status_String

Status_String

Sending/stopped/failed etc. Raw string enum value.

Property Value

string

See Also

PreviewMailingHeader.Status

See Also

MarketingAgent