Class ShipmentMessageEntity

A shipment message, that contains the actual message being sent out in a mailing

Carrier object for ShipmentMessageEntity. Services for the ShipmentMessageEntity Carrier is available from the Marketing Agent.
Inheritance
object
ShipmentMessageEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class ShipmentMessageEntity : Carrier
Examples

Get ShipmentMessageEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new MarketingAgent();
   var shipmentMessageEntity = agent.GetShipmentMessageEntity( 123 );
}

Constructors

ShipmentMessageEntity()

Default constructor

Declaration
public ShipmentMessageEntity()
See Also

Properties

AccessKey

Key used for access verification

Declaration
[DataMember]
public virtual string AccessKey { get; set; }
Property Value
Type Description
string
See Also

Description

Describes this message

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

Design

Will contain the design part of a message. The format will vary based on the type of designer used to create the message

Declaration
[DataMember]
public virtual string Design { get; set; }
Property Value
Type Description
string
See Also

Designtype

Enum containing the type of the design

Declaration
[DataMember]
public virtual DesignType Designtype { get; set; }
Property Value
Type Description
DesignType
See Also

DocumentMessage

The SM document used as template for this mailing

Declaration
[DataMember]
public virtual int DocumentMessage { get; set; }
Property Value
Type Description
int
See Also

Flags

Identifies if HTML or plain message is included in message.

Declaration
[DataMember]
public virtual ShipmentMessageType Flags { get; set; }
Property Value
Type Description
ShipmentMessageType
See Also

FolderId

The folder which this message belongs to. -1 indicates that the message is on the root

Declaration
[DataMember]
public virtual int FolderId { get; set; }
Property Value
Type Description
int
See Also

HeaderField

Extra header fields added to mail. Must be formatted correctly

Declaration
[DataMember]
public virtual string HeaderField { get; set; }
Property Value
Type Description
string
See Also

HtmlMessage

HTML formatted text of this message

Declaration
[DataMember]
public virtual string HtmlMessage { get; set; }
Property Value
Type Description
string
See Also

InlineImages

Should images be included inline?

Declaration
[DataMember]
public virtual bool InlineImages { get; set; }
Property Value
Type Description
bool
See Also

LongDescription

A field for a long description of this template

Declaration
[DataMember]
public virtual string LongDescription { get; set; }
Property Value
Type Description
string
See Also

PlainMessage

Plain message text of this message

Declaration
[DataMember]
public virtual string PlainMessage { get; set; }
Property Value
Type Description
string
See Also

RegisterViews

Register message views?

Declaration
[DataMember]
public virtual bool RegisterViews { get; set; }
Property Value
Type Description
bool
See Also

Registered

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
See Also

RegisteredAssociateId

Registered by whom

Declaration
[DataMember]
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
int
See Also

ShipmentMessageId

Primary key

Declaration
[DataMember]
public virtual int ShipmentMessageId { get; set; }
Property Value
Type Description
int
See Also

SmsMessage

SMS version of this message

Declaration
[DataMember]
public virtual string SmsMessage { get; set; }
Property Value
Type Description
string
See Also

Subject

The mail subject field of the message

Declaration
[DataMember]
public virtual string Subject { get; set; }
Property Value
Type Description
string
See Also

Updated

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
See Also

UpdatedAssociateId

Last updated by whom

Declaration
[DataMember]
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
int
See Also

UpdatedCount

Number of updates made to this record

Declaration
[DataMember]
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
short
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also