Show / Hide Table of Contents

Class SShipmentRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the s_shipment table.

Inheritance
object
SShipmentRecordData
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SShipmentRecordData
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

SShipmentRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the s_shipment table.

Declaration
public SShipmentRecordData()
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

ActivePane

The currently active pane in the mailing wizard

Declaration
public int ActivePane
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ActualCount

Number of emails sent at the last checkpoint

Declaration
public int ActualCount
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ActualRate

The actual rate of messages per minute. can be lower than send_rate

Declaration
public int ActualRate
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ActualTime

The time of the last checkpoint

Declaration
public DateTime ActualTime
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

AreStatisticsDirty

Indicates if shipment needs statistics calculation, set by code that changes the shipment or receives clicks/opens

Declaration
public short AreStatisticsDirty
Field Value
Type Description
short
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ClickNum

Number of links clicked

Declaration
public int ClickNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ClickRate

Click rate % (click_num / delivered_num)

Declaration
public double ClickRate
Field Value
Type Description
double
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Configuration

This field indicates what kind of shipment this is.

Declaration
public int Configuration
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

CurrentSender

Timestamp to identify which ejsender that owns this shipment

Declaration
public int CurrentSender
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DeliveredNum

Number of mails sent minus bounces

Declaration
public int DeliveredNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Description

Describes the shipment

Declaration
public string Description
Field Value
Type Description
string
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

EndDate

Is set when this shipment is ended

Declaration
public DateTime EndDate
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

EnvelopeFrom

Email address for the MTA envelope (where bounces are returned)

Declaration
public string EnvelopeFrom
Field Value
Type Description
string
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Flags

Various flags for a shipment

Declaration
public uint Flags
Field Value
Type Description
uint
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FolderId

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

Declaration
public int FolderId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FromAddr

Email address to put in the From header of the messages

Declaration
public string FromAddr
Field Value
Type Description
string
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

GeneratedDocumentId

ID of the merged document that is the result of the shipment

Declaration
public int GeneratedDocumentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HardbounceNum

Number of hard bounces

Declaration
public int HardbounceNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

HardbounceRate

Hard bounce rate % (hardbounce_num / number_transmitted)

Declaration
public double HardbounceRate
Field Value
Type Description
double
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

MessageId

The id of the message that is sent in this shipment

Declaration
public int MessageId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

OpenNum

Number of opened emails count

Declaration
public int OpenNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

OpenRate

Open rate % (open_num / delivered_num)

Declaration
public double OpenRate
Field Value
Type Description
double
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ProjectId

Set if this shipment should be related to a Project

Declaration
public int ProjectId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Recipients

The total number of recipients to send message to.

Declaration
public int Recipients
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ReplyAddr

Email address to put in the Reply To: header of the messages

Declaration
public string ReplyAddr
Field Value
Type Description
string
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SShipmentId

Primary key

Declaration
public int SShipmentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SelectionId

Set if this shipment should be related to a Selection

Declaration
public int SelectionId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SendRate

Maximum number of messages sent per minute.

Declaration
public int SendRate
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SentNum

Number of mails sent

Declaration
public int SentNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ShipmenttypeId

Id of subscriptionType that this shipment has, so we may check for reservations

Declaration
public int ShipmenttypeId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SmtpPort

The port of the SMTP server to use for this shipment.

Declaration
public int SmtpPort
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SmtpServ

The server to use for this shipment.

Declaration
public string SmtpServ
Field Value
Type Description
string
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SoftbounceNum

Number of soft bounces

Declaration
public int SoftbounceNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SoftbounceRate

Soft bounce rate % (softbounce_num / number_transmitted)

Declaration
public double SoftbounceRate
Field Value
Type Description
double
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Sorting

Which sorting should be used on the document mailing recipient list, used when generating PDF

Declaration
public RecipientSorting Sorting
Field Value
Type Description
RecipientSorting
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

StartDate

The date and time when to start this shipment

Declaration
public DateTime StartDate
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Status

Sending/stopped/failed etc.

Declaration
public ShipmentStatus Status
Field Value
Type Description
ShipmentStatus
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TicketCategory

The category of tickets created while sending out if any. -1 if no ticket should be created

Declaration
public int TicketCategory
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TicketOwner

The owner of the ticket if any is created while sending out a shipment. -1 if no ticket should be automatically delegated, 1 if the ticket is unassigned, >1 for all others

Declaration
public int TicketOwner
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TotalbounceNum

Total number of bounces

Declaration
public int TotalbounceNum
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TotalbounceRate

Total bounce rate % (totalbounce_num / number_transmitted)

Declaration
public double TotalbounceRate
Field Value
Type Description
double
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full SShipmentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding SShipmentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods

EnumUtil.MapEnums<From, To>(From)
SShipmentRecordDataExtensions.ToInsertAsync(SShipmentRecordData, CancellationToken)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top