Class PreviewMailingHeader

A shipment with information intended for previewing it.

Carrier object for PreviewMailingHeader. Services for the PreviewMailingHeader Carrier is available from the Marketing Agent.
Inheritance
object
PreviewMailingHeader
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class PreviewMailingHeader : Carrier

Constructors

PreviewMailingHeader()

Default constructor

Declaration
public PreviewMailingHeader()
See Also

Properties

Configuration

This field indicates what kind of shipment this is.

Declaration
[DataMember]
public virtual int Configuration { get; set; }
Property Value
Type Description
int
See Also

DocumentMessageId

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

Declaration
[DataMember]
public virtual int DocumentMessageId { get; set; }
Property Value
Type Description
int
See Also

FromAddress

Email address to put in the From header of the messages

Declaration
[DataMember]
public virtual string FromAddress { get; set; }
Property Value
Type Description
string
See Also

MessageId

Primary key

Declaration
[DataMember]
public virtual int MessageId { get; set; }
Property Value
Type Description
int
See Also

MessageSubject

The mail subject field of the message

Declaration
[DataMember]
public virtual string MessageSubject { get; set; }
Property Value
Type Description
string
See Also

NumBounced

Number of recipients that resulted in a bounce.

Declaration
[DataMember]
public virtual int NumBounced { get; set; }
Property Value
Type Description
int
See Also

NumClicks

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

Declaration
[DataMember]
public virtual int NumClicks { get; set; }
Property Value
Type Description
int
See Also

NumOpened

Number of recipients that opened the email.

Declaration
[DataMember]
public virtual int NumOpened { get; set; }
Property Value
Type Description
int
See Also

NumSent

Number of emails sent at the current time.

Declaration
[DataMember]
public virtual int NumSent { get; set; }
Property Value
Type Description
int
See Also

PersonFullName

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

Declaration
[DataMember]
public virtual string PersonFullName { get; set; }
Property Value
Type Description
string
See Also

PersonId

Primary key

Declaration
[DataMember]
public virtual int PersonId { get; set; }
Property Value
Type Description
int
See Also

ShipmentDescription

Describes the shipment

Declaration
[DataMember]
public virtual string ShipmentDescription { get; set; }
Property Value
Type Description
string
See Also

ShipmentId

Primary key

Declaration
[DataMember]
public virtual int ShipmentId { get; set; }
Property Value
Type Description
int
See Also

ShipmentType

The list item

Declaration
[DataMember]
public virtual string ShipmentType { get; set; }
Property Value
Type Description
string
See Also

StartDate

The date and time when to start this shipment

Declaration
[DataMember]
public virtual DateTime StartDate { get; set; }
Property Value
Type Description
DateTime
See Also

Status

Sending/stopped/failed etc.

Declaration
[DataMember]
public virtual ShipmentStatus Status { get; set; }
Property Value
Type Description
ShipmentStatus
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also