Class PreviewMailingHeader
A shipment with information intended for previewing it.
Carrier object for PreviewMailingHeader. Services for the PreviewMailingHeader Carrier is available from the IMarketingAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class PreviewMailingHeader : CarrierConstructors
PreviewMailingHeader()
Default constructor
Declaration
public PreviewMailingHeader()See Also
Properties
Configuration
This field indicates what kind of shipment this is.
Declaration
public virtual int Configuration { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
DocumentMessageId
If a document was used as the message this is the document ID.
Declaration
public virtual int DocumentMessageId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
FromAddress
Email address to put in the From header of the messages
Declaration
public virtual string FromAddress { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
MessageId
Primary key
Declaration
public virtual int MessageId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
MessageSubject
The mail subject field of the message
Declaration
public virtual string MessageSubject { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
NumBounced
Number of recipients that resulted in a bounce.
Declaration
public virtual int NumBounced { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
NumClicks
Number of recipients that clicked at least 1 link in the mailing.
Declaration
public virtual int NumClicks { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
NumOpened
Number of recipients that opened the email.
Declaration
public virtual int NumOpened { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
NumSent
Number of emails sent at the current time.
Declaration
public virtual int NumSent { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
PersonFullName
Get the persons full name (internal name used in clients for employees).
Declaration
public virtual string PersonFullName { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
PersonId
Primary key
Declaration
public virtual int PersonId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
ShipmentDescription
Describes the shipment
Declaration
public virtual string ShipmentDescription { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
ShipmentId
Primary key
Declaration
public virtual int ShipmentId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
ShipmentType
The list item
Declaration
public virtual string ShipmentType { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
StartDate
The date and time when to start this shipment
Declaration
public virtual DateTime StartDate { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
See Also
Status
Sending/stopped/failed etc.
Declaration
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. |