Class NSPreviewMailingHeader

Syntax

Constructors

NSPreviewMailingHeader()

Declaration

NSPreviewMailingHeader

Methods

GetDocumentMessageId()

Declaration

Integer GetDocumentMessageId()

Returns

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

Examples

NSPreviewMailingHeader thing;
Integer documentMessageId = thing.GetDocumentMessageId();

GetFromAddress()

Declaration

String GetFromAddress()

Returns

Type	Description
String	Email address to put in the From header of the messages.

Examples

NSPreviewMailingHeader thing;
String fromAddress = thing.GetFromAddress();

GetMessageId()

Declaration

Integer GetMessageId()

Returns

Type	Description
Integer	Primary key.

Examples

NSPreviewMailingHeader thing;
Integer messageId = thing.GetMessageId();

GetMessageSubject()

Declaration

String GetMessageSubject()

Returns

Type	Description
String	The mail subject field of the message.

Examples

NSPreviewMailingHeader thing;
String messageSubject = thing.GetMessageSubject();

GetNumBounced()

Declaration

Integer GetNumBounced()

Returns

Type	Description
Integer	Number of recipients that resulted in a bounce.

Examples

NSPreviewMailingHeader thing;
Integer numBounced = thing.GetNumBounced();

GetNumClicks()

Declaration

Integer GetNumClicks()

Returns

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

Examples

NSPreviewMailingHeader thing;
Integer numClicks = thing.GetNumClicks();

GetNumOpened()

Declaration

Integer GetNumOpened()

Returns

Type	Description
Integer	Number of recipients that opened the email.

Examples

NSPreviewMailingHeader thing;
Integer numOpened = thing.GetNumOpened();

GetNumSent()

Declaration

Integer GetNumSent()

Returns

Type	Description
Integer	Number of emails sent at the current time.

Examples

NSPreviewMailingHeader thing;
Integer numSent = thing.GetNumSent();

GetPersonFullName()

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

Declaration

String GetPersonFullName()

Returns

Type	Description
String

Examples

NSPreviewMailingHeader thing;
String personFullName = thing.GetPersonFullName();

GetPersonId()

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Primary key.

Examples

NSPreviewMailingHeader thing;
Integer personId = thing.GetPersonId();

GetShipmentDescription()

Declaration

String GetShipmentDescription()

Returns

Type	Description
String	Describes the shipment.

Examples

NSPreviewMailingHeader thing;
String shipmentDescription = thing.GetShipmentDescription();

GetShipmentId()

Declaration

Integer GetShipmentId()

Returns

Type	Description
Integer	Primary key.

Examples

NSPreviewMailingHeader thing;
Integer shipmentId = thing.GetShipmentId();

GetShipmentType()

Declaration

String GetShipmentType()

Returns

Type	Description
String	The list item.

Examples

NSPreviewMailingHeader thing;
String shipmentType = thing.GetShipmentType();

GetStartDate()

Declaration

DateTime GetStartDate()

Returns

Type	Description
DateTime	The date and time when to start this shipment.

Examples

NSPreviewMailingHeader thing;
DateTime startDate = thing.GetStartDate();

GetStatus()

Declaration

Integer GetStatus()

Returns

Type	Description
Integer	Sending/stopped/failed etc. See ShipmentStatus.

Examples

NSPreviewMailingHeader thing;
Integer status = thing.GetStatus();

SetDocumentMessageId(Integer)

Declaration

Void SetDocumentMessageId(Integer documentMessageId)

Parameters

Type	Name	Description
Integer	documentMessageId	If a document was used as the message this is the document ID.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer documentMessageId;
thing.SetDocumentMessageId(documentMessageId);

SetFromAddress(String)

Declaration

Void SetFromAddress(String fromAddress)

Parameters

Type	Name	Description
String	fromAddress	Email address to put in the From header of the messages.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
String fromAddress;
thing.SetFromAddress(fromAddress);

SetMessageId(Integer)

Declaration

Void SetMessageId(Integer messageId)

Parameters

Type	Name	Description
Integer	messageId	Primary key.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer messageId;
thing.SetMessageId(messageId);

SetMessageSubject(String)

Declaration

Void SetMessageSubject(String messageSubject)

Parameters

Type	Name	Description
String	messageSubject	The mail subject field of the message.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
String messageSubject;
thing.SetMessageSubject(messageSubject);

SetNumBounced(Integer)

Declaration

Void SetNumBounced(Integer numBounced)

Parameters

Type	Name	Description
Integer	numBounced	Number of recipients that resulted in a bounce.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer numBounced;
thing.SetNumBounced(numBounced);

SetNumClicks(Integer)

Declaration

Void SetNumClicks(Integer numClicks)

Parameters

Type	Name	Description
Integer	numClicks	Number of recipients that clicked at least 1 link in the mailing.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer numClicks;
thing.SetNumClicks(numClicks);

SetNumOpened(Integer)

Declaration

Void SetNumOpened(Integer numOpened)

Parameters

Type	Name	Description
Integer	numOpened	Number of recipients that opened the email.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer numOpened;
thing.SetNumOpened(numOpened);

SetNumSent(Integer)

Declaration

Void SetNumSent(Integer numSent)

Parameters

Type	Name	Description
Integer	numSent	Number of emails sent at the current time.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer numSent;
thing.SetNumSent(numSent);

SetPersonFullName(String)

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

Declaration

Void SetPersonFullName(String personFullName)

Parameters

Type	Name	Description
String	personFullName

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
String personFullName;
thing.SetPersonFullName(personFullName);

SetPersonId(Integer)

Declaration

Void SetPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId	Primary key.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer personId;
thing.SetPersonId(personId);

SetShipmentDescription(String)

Declaration

Void SetShipmentDescription(String shipmentDescription)

Parameters

Type	Name	Description
String	shipmentDescription	Describes the shipment.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
String shipmentDescription;
thing.SetShipmentDescription(shipmentDescription);

SetShipmentId(Integer)

Declaration

Void SetShipmentId(Integer shipmentId)

Parameters

Type	Name	Description
Integer	shipmentId	Primary key.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer shipmentId;
thing.SetShipmentId(shipmentId);

SetShipmentType(String)

Declaration

Void SetShipmentType(String shipmentType)

Parameters

Type	Name	Description
String	shipmentType	The list item.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
String shipmentType;
thing.SetShipmentType(shipmentType);

SetStartDate(DateTime)

Declaration

Void SetStartDate(DateTime startDate)

Parameters

Type	Name	Description
DateTime	startDate	The date and time when to start this shipment.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
DateTime startDate;
thing.SetStartDate(startDate);

SetStatus(Integer)

Declaration

Void SetStatus(Integer status)

Parameters

Type	Name	Description
Integer	status	Sending/stopped/failed etc. See ShipmentStatus.

Returns

Type	Description
Void

Examples

NSPreviewMailingHeader thing;
Integer status;
thing.SetStatus(status);