Class NSPreviewMailing

Syntax

Constructors

NSPreviewMailing()

Declaration

NSPreviewMailing

Methods

GetContactId()

Declaration

Integer GetContactId()

Returns

Type	Description
Integer	Owning contact Id.

Examples

NSPreviewMailing thing;
Integer contactId = thing.GetContactId();

GetContactName()

Declaration

String GetContactName()

Returns

Type	Description
String	Contact name.

Examples

NSPreviewMailing thing;
String contactName = thing.GetContactName();

GetDocumentMessageId()

Declaration

Integer GetDocumentMessageId()

Returns

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

Examples

NSPreviewMailing 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

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

GetLinkClicks()

Declaration

Integer GetLinkClicks()

Returns

Type	Description
Integer	The number of links clicked in the mailing.

Examples

NSPreviewMailing thing;
Integer linkClicks = thing.GetLinkClicks();

GetMessageId()

Declaration

Integer GetMessageId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetMessageSubject()

Declaration

String GetMessageSubject()

Returns

Type	Description
String	The mail subject field of the message.

Examples

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

GetOpened()

Declaration

DateTime GetOpened()

Returns

Type	Description
DateTime	Date/time the customer read the mailing.

Examples

NSPreviewMailing thing;
DateTime opened = thing.GetOpened();

GetPersonFullName()

Declaration

String GetPersonFullName()

Returns

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

Examples

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

GetPersonId()

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetSendingTime()

Declaration

DateTime GetSendingTime()

Returns

Type	Description
DateTime	Estimated or actual sent time (depends on status).

Examples

NSPreviewMailing thing;
DateTime sendingTime = thing.GetSendingTime();

GetShipmentDescription()

Declaration

String GetShipmentDescription()

Returns

Type	Description
String	Describes the shipment.

Examples

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

GetShipmentId()

Declaration

Integer GetShipmentId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetShipmentType()

Declaration

String GetShipmentType()

Returns

Type	Description
String	The list item.

Examples

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

GetStatus()

Declaration

Integer GetStatus()

Returns

Type	Description
Integer	Status for sending to this particular recipient. See ShipmentAddrStatus.

Examples

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

SetContactId(Integer)

Declaration

Void SetContactId(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId	Owning contact Id.

Returns

Type	Description
Void

Examples

NSPreviewMailing thing;
Integer contactId;
thing.SetContactId(contactId);

SetContactName(String)

Declaration

Void SetContactName(String contactName)

Parameters

Type	Name	Description
String	contactName	Contact name.

Returns

Type	Description
Void

Examples

NSPreviewMailing thing;
String contactName;
thing.SetContactName(contactName);

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

NSPreviewMailing 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

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

SetLinkClicks(Integer)

Declaration

Void SetLinkClicks(Integer linkClicks)

Parameters

Type	Name	Description
Integer	linkClicks	The number of links clicked in the mailing.

Returns

Type	Description
Void

Examples

NSPreviewMailing thing;
Integer linkClicks;
thing.SetLinkClicks(linkClicks);

SetMessageId(Integer)

Declaration

Void SetMessageId(Integer messageId)

Parameters

Type	Name	Description
Integer	messageId	Primary key.

Returns

Type	Description
Void

Examples

NSPreviewMailing 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

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

SetOpened(DateTime)

Declaration

Void SetOpened(DateTime opened)

Parameters

Type	Name	Description
DateTime	opened	Date/time the customer read the mailing.

Returns

Type	Description
Void

Examples

NSPreviewMailing thing;
DateTime opened;
thing.SetOpened(opened);

SetPersonFullName(String)

Declaration

Void SetPersonFullName(String personFullName)

Parameters

Type	Name	Description
String	personFullName	The persons full name (internal name used in clients for employees).

Returns

Type	Description
Void

Examples

NSPreviewMailing 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

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

SetSendingTime(DateTime)

Declaration

Void SetSendingTime(DateTime )

Parameters

Type	Name	Description
DateTime	sendingTime	Estimated or actual sent time (depends on status).

Returns

Type	Description
Void

Examples

NSPreviewMailing thing;
DateTime sendingTime;
thing.SetSendingTime(sendingTime);

SetShipmentDescription(String)

Declaration

Void SetShipmentDescription(String shipmentDescription)

Parameters

Type	Name	Description
String	shipmentDescription	Describes the shipment.

Returns

Type	Description
Void

Examples

NSPreviewMailing 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

NSPreviewMailing 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

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

SetStatus(Integer)

Declaration

Void SetStatus(Integer status)

Parameters

Type	Name	Description
Integer	status	Status for sending to this particular recipient. See ShipmentAddrStatus.

Returns

Type	Description
Void

Examples

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