> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSShipmentMessageEntity

## Constructors

### NSShipmentMessageEntity()

```crmscript theme={null}
NSShipmentMessageEntity
```

Initializes a new instance of the NSShipmentMessageEntity class.

## Methods

## GetAccessKey()

```crmscript theme={null}
String GetAccessKey()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Key used for access verification.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String accessKey = thing.GetAccessKey();
```

## GetDescription()

```crmscript theme={null}
String GetDescription()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Describes this message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String description = thing.GetDescription();
```

## GetDesign()

```crmscript theme={null}
String GetDesign()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Will contain the design part of a message. The format will vary based on the type of designer used to create the message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String design = thing.GetDesign();
```

## GetDesigntype()

```crmscript theme={null}
Integer GetDesigntype()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The type of the design. See \<xref href="CRMScript.NetServer.DesignType" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer designType = thing.GetDesigntype();
```

## GetDocumentMessage()

```crmscript theme={null}
Integer GetDocumentMessage()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The SM document used as template for this mailing.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer documentMessage = thing.GetDocumentMessage();
```

## GetFlags()

```crmscript theme={null}
Integer GetFlags()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Identifies if HTML or plain message is included in message. See \<xref href="CRMScript.NetServer.ShipmentMessageType" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer flags = thing.GetFlags();
```

## GetFolderId()

```crmscript theme={null}
Integer GetFolderId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The folder which this message belongs to. -1 indicates that the message is on the root.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer folderId = thing.GetFolderId();
```

## GetHeaderField()

```crmscript theme={null}
String GetHeaderField()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Extra header fields added to mail. Must be formatted correctly.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String headerField = thing.GetHeaderField();
```

## GetHtmlMessage()

```crmscript theme={null}
String GetHtmlMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - HTML formatted text of this message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String htmlMessage = thing.GetHtmlMessage();
```

## GetInlineImages()

```crmscript theme={null}
Bool GetInlineImages()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Should images be included inline?

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Bool inlineImages = thing.GetInlineImages();
```

## GetLongDescription()

```crmscript theme={null}
String GetLongDescription()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - A field for a long description of this template.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String longDescription = thing.GetLongDescription();
```

## GetPlainMessage()

```crmscript theme={null}
String GetPlainMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Plain message text of this message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String plainMessage = thing.GetPlainMessage();
```

## GetRegistered()

```crmscript theme={null}
DateTime GetRegistered()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Registered when.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
DateTime registered = thing.GetRegistered();
```

## GetRegisteredAssociateId()

```crmscript theme={null}
Integer GetRegisteredAssociateId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Registered by whom.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer registeredAssociateId = thing.GetRegisteredAssociateId();
```

## GetRegisterViews()

```crmscript theme={null}
Bool GetRegisterViews()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Register message views?

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Bool registerViews = thing.GetRegisterViews();
```

## GetShipmentMessageId()

```crmscript theme={null}
Integer GetShipmentMessageId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer shipmentMessageId = thing.GetShipmentMessageId();
```

## GetSmsMessage()

```crmscript theme={null}
String GetSmsMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - SMS version of this message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String smsMessage = thing.GetSmsMessage();
```

## GetSubject()

```crmscript theme={null}
String GetSubject()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The mail subject field of the message.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String subject = thing.GetSubject();
```

## GetUpdated()

```crmscript theme={null}
DateTime GetUpdated()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Last updated when.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
DateTime updated = thing.GetUpdated();
```

## GetUpdatedAssociateId()

```crmscript theme={null}
Integer GetUpdatedAssociateId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Last updated by whom.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer updatedAssociateId = thing.GetUpdatedAssociateId();
```

## GetUpdatedCount()

```crmscript theme={null}
Integer GetUpdatedCount()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of updates made to this record.

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer updatedCount = thing.GetUpdatedCount();
```

## SetAccessKey(String)

```crmscript theme={null}
Void SetAccessKey(String accessKey)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String accessKey;
thing.SetAccessKey(accessKey);
```

## SetDescription(String)

```crmscript theme={null}
Void SetDescription(String description)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String description;
thing.SetDescription(description);
```

## SetDesign(String)

```crmscript theme={null}
Void SetDesign(String design)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String design;
thing.SetDesign(design);
```

## SetDesigntype(Integer)

```crmscript theme={null}
Void SetDesigntype(Integer designType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer designType;
thing.SetDesigntype(designType);
```

## SetDocumentMessage(Integer)

```crmscript theme={null}
Void SetDocumentMessage(Integer documentMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer documentMessage;
thing.SetDocumentMessage(documentMessage);
```

## SetFlags(Integer)

```crmscript theme={null}
Void SetFlags(Integer flags)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer flags;
thing.SetFlags(flags);
```

## SetFolderId(Integer)

```crmscript theme={null}
Void SetFolderId(Integer folderId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer folderId;
thing.SetFolderId(folderId);
```

## SetHeaderField(String)

```crmscript theme={null}
Void SetHeaderField(String headerField)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String headerField;
thing.SetHeaderField(headerField);
```

## SetHtmlMessage(String)

```crmscript theme={null}
Void SetHtmlMessage(String htmlMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String htmlMessage;
thing.SetHtmlMessage(htmlMessage);
```

## SetInlineImages(Bool)

```crmscript theme={null}
Void SetInlineImages(Bool inlineImages)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Bool inlineImages;
thing.SetInlineImages(inlineImages);
```

## SetLongDescription(String)

```crmscript theme={null}
Void SetLongDescription(String longDescription)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String longDescription;
thing.SetLongDescription(longDescription);
```

## SetPlainMessage(String)

```crmscript theme={null}
Void SetPlainMessage(String plainMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String plainMessage;
thing.SetPlainMessage(plainMessage);
```

## SetRegistered(DateTime)

```crmscript theme={null}
Void SetRegistered(DateTime registered)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
DateTime registered;
thing.SetRegistered(registered);
```

## SetRegisteredAssociateId(Integer)

```crmscript theme={null}
Void SetRegisteredAssociateId(Integer registeredAssociateId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer registeredAssociateId;
thing.SetRegisteredAssociateId(registeredAssociateId);
```

## SetRegisterViews(Bool)

```crmscript theme={null}
Void SetRegisterViews(Bool registerViews)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Bool registerViews;
thing.SetRegisterViews(registerViews);
```

## SetShipmentMessageId(Integer)

```crmscript theme={null}
Void SetShipmentMessageId(Integer shipmentMessageId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer shipmentMessageId;
thing.SetShipmentMessageId(shipmentMessageId);
```

## SetSmsMessage(String)

```crmscript theme={null}
Void SetSmsMessage(String smsMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String smsMessage;
thing.SetSmsMessage(smsMessage);
```

## SetSubject(String)

```crmscript theme={null}
Void SetSubject(String subject)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
String subject;
thing.SetSubject(subject);
```

## SetUpdated(DateTime)

```crmscript theme={null}
Void SetUpdated(DateTime updated)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
DateTime updated;
thing.SetUpdated(updated);
```

## SetUpdatedAssociateId(Integer)

```crmscript theme={null}
Void SetUpdatedAssociateId(Integer updatedAssociateId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer updatedAssociateId;
thing.SetUpdatedAssociateId(updatedAssociateId);
```

## SetUpdatedCount(Integer)

```crmscript theme={null}
Void SetUpdatedCount(Integer updatedCount)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSShipmentMessageEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);
```


## Related topics

- [NSMarketingAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSMarketingAgent.md)
- [Delete Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/delete-shipment-message-entity.md)
- [Get Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/get-shipment-message-entity.md)
- [Post Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/post-shipment-message-entity.md)
- [Default Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/default-shipment-message-entity.md)
- [Put Shipment Message Entity](/en/api/reference/restful/rest/shipmentmessage/put-shipment-message-entity.md)