Class NSPreviewMailingHeader
Constructors
NSPreviewMailingHeader()
Declaration
NSPreviewMailingHeaderMethods
GetDocumentMessageId()
Declaration
Integer GetDocumentMessageId()Examples
NSPreviewMailingHeader thing;
Integer documentMessageId = thing.GetDocumentMessageId();Returns
| Type | Description |
| Integer | If a document was used as the message this is the document ID. |
GetFromAddress()
Declaration
String GetFromAddress()Examples
NSPreviewMailingHeader thing;
String fromAddress = thing.GetFromAddress();Returns
| Type | Description |
| String | Email address to put in the From header of the messages. |
GetMessageId()
Declaration
Integer GetMessageId()Examples
NSPreviewMailingHeader thing;
Integer messageId = thing.GetMessageId();Returns
| Type | Description |
| Integer | Primary key. |
GetMessageSubject()
Declaration
String GetMessageSubject()Examples
NSPreviewMailingHeader thing;
String messageSubject = thing.GetMessageSubject();Returns
| Type | Description |
| String | The mail subject field of the message. |
GetNumBounced()
Declaration
Integer GetNumBounced()Examples
NSPreviewMailingHeader thing;
Integer numBounced = thing.GetNumBounced();Returns
| Type | Description |
| Integer | Number of recipients that resulted in a bounce. |
GetNumClicks()
Declaration
Integer GetNumClicks()Examples
NSPreviewMailingHeader thing;
Integer numClicks = thing.GetNumClicks();Returns
| Type | Description |
| Integer | Number of recipients that clicked at least 1 link in the mailing. |
GetNumOpened()
Declaration
Integer GetNumOpened()Examples
NSPreviewMailingHeader thing;
Integer numOpened = thing.GetNumOpened();Returns
| Type | Description |
| Integer | Number of recipients that opened the email. |
GetNumSent()
Declaration
Integer GetNumSent()Examples
NSPreviewMailingHeader thing;
Integer numSent = thing.GetNumSent();Returns
| Type | Description |
| Integer | Number of emails sent at the current time. |
GetPersonFullName()
Gets the persons full name (internal name used in clients for employees).
Declaration
String GetPersonFullName()Examples
NSPreviewMailingHeader thing;
String personFullName = thing.GetPersonFullName();Returns
| Type | Description |
| String |
GetPersonId()
Declaration
Integer GetPersonId()Examples
NSPreviewMailingHeader thing;
Integer personId = thing.GetPersonId();Returns
| Type | Description |
| Integer | Primary key. |
GetShipmentDescription()
Declaration
String GetShipmentDescription()Examples
NSPreviewMailingHeader thing;
String shipmentDescription = thing.GetShipmentDescription();Returns
| Type | Description |
| String | Describes the shipment. |
GetShipmentId()
Declaration
Integer GetShipmentId()Examples
NSPreviewMailingHeader thing;
Integer shipmentId = thing.GetShipmentId();Returns
| Type | Description |
| Integer | Primary key. |
GetShipmentType()
Declaration
String GetShipmentType()Examples
NSPreviewMailingHeader thing;
String shipmentType = thing.GetShipmentType();Returns
| Type | Description |
| String | The list item. |
GetStartDate()
Declaration
DateTime GetStartDate()Examples
NSPreviewMailingHeader thing;
DateTime startDate = thing.GetStartDate();Returns
| Type | Description |
| DateTime | The date and time when to start this shipment. |
GetStatus()
Declaration
Integer GetStatus()Examples
NSPreviewMailingHeader thing;
Integer status = thing.GetStatus();Returns
| Type | Description |
| Integer | Sending/stopped/failed etc. See <xref href="CRMScript.NetServer.ShipmentStatus" data-throw-if-not-resolved="false"></xref>. |
SetDocumentMessageId(Integer)
Declaration
Void SetDocumentMessageId(Integer documentMessageId)Examples
NSPreviewMailingHeader thing;
Integer documentMessageId;
thing.SetDocumentMessageId(documentMessageId);Parameters
| Type | Name | Description |
| Integer | documentMessageId | If a document was used as the message this is the document ID. |
Returns
| Type | Description |
| Void |
SetFromAddress(String)
Declaration
Void SetFromAddress(String fromAddress)Examples
NSPreviewMailingHeader thing;
String fromAddress;
thing.SetFromAddress(fromAddress);Parameters
| Type | Name | Description |
| String | fromAddress | Email address to put in the From header of the messages. |
Returns
| Type | Description |
| Void |
SetMessageId(Integer)
Declaration
Void SetMessageId(Integer messageId)Examples
NSPreviewMailingHeader thing;
Integer messageId;
thing.SetMessageId(messageId);Parameters
| Type | Name | Description |
| Integer | messageId | Primary key. |
Returns
| Type | Description |
| Void |
SetMessageSubject(String)
Declaration
Void SetMessageSubject(String messageSubject)Examples
NSPreviewMailingHeader thing;
String messageSubject;
thing.SetMessageSubject(messageSubject);Parameters
| Type | Name | Description |
| String | messageSubject | The mail subject field of the message. |
Returns
| Type | Description |
| Void |
SetNumBounced(Integer)
Declaration
Void SetNumBounced(Integer numBounced)Examples
NSPreviewMailingHeader thing;
Integer numBounced;
thing.SetNumBounced(numBounced);Parameters
| Type | Name | Description |
| Integer | numBounced | Number of recipients that resulted in a bounce. |
Returns
| Type | Description |
| Void |
SetNumClicks(Integer)
Declaration
Void SetNumClicks(Integer numClicks)Examples
NSPreviewMailingHeader thing;
Integer numClicks;
thing.SetNumClicks(numClicks);Parameters
| Type | Name | Description |
| Integer | numClicks | Number of recipients that clicked at least 1 link in the mailing. |
Returns
| Type | Description |
| Void |
SetNumOpened(Integer)
Declaration
Void SetNumOpened(Integer numOpened)Examples
NSPreviewMailingHeader thing;
Integer numOpened;
thing.SetNumOpened(numOpened);Parameters
| Type | Name | Description |
| Integer | numOpened | Number of recipients that opened the email. |
Returns
| Type | Description |
| Void |
SetNumSent(Integer)
Declaration
Void SetNumSent(Integer numSent)Examples
NSPreviewMailingHeader thing;
Integer numSent;
thing.SetNumSent(numSent);Parameters
| Type | Name | Description |
| Integer | numSent | Number of emails sent at the current time. |
Returns
| Type | Description |
| Void |
SetPersonFullName(String)
Gets the persons full name (internal name used in clients for employees).
Declaration
Void SetPersonFullName(String personFullName)Examples
NSPreviewMailingHeader thing;
String personFullName;
thing.SetPersonFullName(personFullName);Parameters
| Type | Name | Description |
| String | personFullName |
Returns
| Type | Description |
| Void |
SetPersonId(Integer)
Declaration
Void SetPersonId(Integer personId)Examples
NSPreviewMailingHeader thing;
Integer personId;
thing.SetPersonId(personId);Parameters
| Type | Name | Description |
| Integer | personId | Primary key. |
Returns
| Type | Description |
| Void |
SetShipmentDescription(String)
Declaration
Void SetShipmentDescription(String shipmentDescription)Examples
NSPreviewMailingHeader thing;
String shipmentDescription;
thing.SetShipmentDescription(shipmentDescription);Parameters
| Type | Name | Description |
| String | shipmentDescription | Describes the shipment. |
Returns
| Type | Description |
| Void |
SetShipmentId(Integer)
Declaration
Void SetShipmentId(Integer shipmentId)Examples
NSPreviewMailingHeader thing;
Integer shipmentId;
thing.SetShipmentId(shipmentId);Parameters
| Type | Name | Description |
| Integer | shipmentId | Primary key. |
Returns
| Type | Description |
| Void |
SetShipmentType(String)
Declaration
Void SetShipmentType(String shipmentType)Examples
NSPreviewMailingHeader thing;
String shipmentType;
thing.SetShipmentType(shipmentType);Parameters
| Type | Name | Description |
| String | shipmentType | The list item. |
Returns
| Type | Description |
| Void |
SetStartDate(DateTime)
Declaration
Void SetStartDate(DateTime startDate)Examples
NSPreviewMailingHeader thing;
DateTime startDate;
thing.SetStartDate(startDate);Parameters
| Type | Name | Description |
| DateTime | startDate | The date and time when to start this shipment. |
Returns
| Type | Description |
| Void |
SetStatus(Integer)
Declaration
Void SetStatus(Integer status)Examples
NSPreviewMailingHeader thing;
Integer status;
thing.SetStatus(status);Parameters
| Type | Name | Description |
| Integer | status | Sending/stopped/failed etc. See <xref href="CRMScript.NetServer.ShipmentStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |