Class ShipmentMessageEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for ShipmentMessageEntity.
A shipment message, that contains the actual message being sent out in a mailing
Inheritance
object ←
Carrier ←
ShipmentMessageEntity
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get ShipmentMessageEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var shipmentMessageEntity = agent.GetShipmentMessageEntity( 123 );
Constructors
ShipmentMessageEntity()
Default constructor - defaults any enum props to 0.
Properties
AccessKey
Key used for access verification
Property Value
string
Description
Describes this message
Property Value
string
Design
Will contain the design part of a message. The format will vary based on the type of designer used to create the message
Property Value
string
Designtype
Enum containing the type of the design
NULL if unknown enum value.
Property Value
DesignType?
See Also
ShipmentMessageEntity.Designtype_String
Designtype_String
Enum containing the type of the design
Raw string enum value.
Property Value
string
See Also
ShipmentMessageEntity.Designtype
DocumentMessage
The SM document used as template for this mailing
Property Value
int
Flags
Identifies if HTML or plain message is included in message.
NULL if unknown enum value.
Property Value
ShipmentMessageType?
See Also
ShipmentMessageEntity.Flags_String
Flags_String
Identifies if HTML or plain message is included in message.
Raw string enum value.
Property Value
string
See Also
ShipmentMessageEntity.Flags
FolderId
The folder which this message belongs to. -1 indicates that the message is on the root
Property Value
int
Extra header fields added to mail. Must be formatted correctly
Property Value
string
HtmlMessage
HTML formatted text of this message
Property Value
string
InlineImages
Should images be included inline?
Property Value
bool
LongDescription
A field for a long description of this template
Property Value
string
PlainMessage
Plain message text of this message
Property Value
string
RegisterViews
Register message views?
Property Value
bool
Registered
Registered when
Property Value
DateTime
RegisteredAssociateId
Registered by whom
Property Value
int
ShipmentMessageId
Primary key
Property Value
int
SmsMessage
SMS version of this message
Property Value
string
Subject
The mail subject field of the message
Property Value
string
Updated
Last updated when
Property Value
DateTime
UpdatedAssociateId
Last updated by whom
Property Value
int
UpdatedCount
Number of updates made to this record
Property Value
short
See Also
MarketingAgent
