Class DBC.SShipmentFields
Fields for SShipment, Contains info about one shipment. The addresses are stored in s_shipment_addr
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
public static class SShipmentFields : ObjectFields
ActivePane
SShipment.ActivePane: The currently active pane in the mailing wizard
Declaration
public const string ActivePane = "active_pane"Field Value
| Type | Description |
|---|---|
| String |
ActualCount
SShipment.ActualCount: Number of emails sent at the last checkpoint
Declaration
public const string ActualCount = "actual_count"Field Value
| Type | Description |
|---|---|
| String |
ActualRate
SShipment.ActualRate: The actual rate of messages per minute. can be lower than send_rate
Declaration
public const string ActualRate = "actual_rate"Field Value
| Type | Description |
|---|---|
| String |
ActualTime
SShipment.ActualTime: The time of the last checkpoint
Declaration
public const string ActualTime = "actual_time"Field Value
| Type | Description |
|---|---|
| String |
AreStatisticsDirty
SShipment.AreStatisticsDirty: Indicates if shipment needs statistics calculation, set by code that changes the shipment or receives clicks/opens
Declaration
public const string AreStatisticsDirty = "are_statistics_dirty"Field Value
| Type | Description |
|---|---|
| String |
ClickNum
SShipment.ClickNum: Number of links clicked
Declaration
public const string ClickNum = "click_num"Field Value
| Type | Description |
|---|---|
| String |
ClickRate
SShipment.ClickRate: Click rate % (click_num / delivered_num)
Declaration
public const string ClickRate = "click_rate"Field Value
| Type | Description |
|---|---|
| String |
Configuration
SShipment.Configuration: This field indicates what kind of shipment this is.
Declaration
public const string Configuration = "configuration"Field Value
| Type | Description |
|---|---|
| String |
CurrentSender
SShipment.CurrentSender: Timestamp to identify which ejsender that owns this shipment
Declaration
public const string CurrentSender = "current_sender"Field Value
| Type | Description |
|---|---|
| String |
DeliveredNum
SShipment.DeliveredNum: Number of mails sent minus bounces
Declaration
public const string DeliveredNum = "delivered_num"Field Value
| Type | Description |
|---|---|
| String |
Description
SShipment.Description: Describes the shipment
Declaration
public const string Description = "description"Field Value
| Type | Description |
|---|---|
| String |
EndDate
SShipment.EndDate: Is set when this shipment is ended
Declaration
public const string EndDate = "end_date"Field Value
| Type | Description |
|---|---|
| String |
EnvelopeFrom
SShipment.EnvelopeFrom: Email address for the MTA envelope (where bounces are returned)
Declaration
public const string EnvelopeFrom = "envelope_from"Field Value
| Type | Description |
|---|---|
| String |
Flags
SShipment.Flags: Various flags for a shipment
Declaration
public const string Flags = "flags"Field Value
| Type | Description |
|---|---|
| String |
FolderId
SShipment.FolderId: The folder which this shipment belongs to. -1 indicates that the shipment is on the root
Declaration
public const string FolderId = "folder_id"Field Value
| Type | Description |
|---|---|
| String |
FromAddr
SShipment.FromAddr: Email address to put in the From header of the messages
Declaration
public const string FromAddr = "from_addr"Field Value
| Type | Description |
|---|---|
| String |
GeneratedDocumentId
SShipment.GeneratedDocumentId: ID of the merged document that is the result of the shipment
Declaration
public const string GeneratedDocumentId = "generated_document_id"Field Value
| Type | Description |
|---|---|
| String |
HardbounceNum
SShipment.HardbounceNum: Number of hard bounces
Declaration
public const string HardbounceNum = "hardbounce_num"Field Value
| Type | Description |
|---|---|
| String |
HardbounceRate
SShipment.HardbounceRate: Hard bounce rate % (hardbounce_num / number_transmitted)
Declaration
public const string HardbounceRate = "hardbounce_rate"Field Value
| Type | Description |
|---|---|
| String |
MessageId
SShipment.MessageId: The id of the message that is sent in this shipment
Declaration
public const string MessageId = "message_id"Field Value
| Type | Description |
|---|---|
| String |
OpenNum
SShipment.OpenNum: Number of opened emails count
Declaration
public const string OpenNum = "open_num"Field Value
| Type | Description |
|---|---|
| String |
OpenRate
SShipment.OpenRate: Open rate % (open_num / delivered_num)
Declaration
public const string OpenRate = "open_rate"Field Value
| Type | Description |
|---|---|
| String |
ProjectId
SShipment.ProjectId: Set if this shipment should be related to a Project
Declaration
public const string ProjectId = "project_id"Field Value
| Type | Description |
|---|---|
| String |
Recipients
SShipment.Recipients: The total number of recipients to send message to.
Declaration
public const string Recipients = "recipients"Field Value
| Type | Description |
|---|---|
| String |
Registered
SShipment.Registered: Registered when
Declaration
public const string Registered = "registered"Field Value
| Type | Description |
|---|---|
| String |
RegisteredAssociateId
SShipment.RegisteredAssociateId: Registered by whom
Declaration
public const string RegisteredAssociateId = "registered_associate_id"Field Value
| Type | Description |
|---|---|
| String |
ReplyAddr
SShipment.ReplyAddr: Email address to put in the Reply To: header of the messages
Declaration
public const string ReplyAddr = "reply_addr"Field Value
| Type | Description |
|---|---|
| String |
SelectionId
SShipment.SelectionId: Set if this shipment should be related to a Selection
Declaration
public const string SelectionId = "selection_id"Field Value
| Type | Description |
|---|---|
| String |
SendRate
SShipment.SendRate: Maximum number of messages sent per minute.
Declaration
public const string SendRate = "send_rate"Field Value
| Type | Description |
|---|---|
| String |
SentNum
SShipment.SentNum: Number of mails sent
Declaration
public const string SentNum = "sent_num"Field Value
| Type | Description |
|---|---|
| String |
ShipmenttypeId
SShipment.ShipmenttypeId: Id of subscriptionType that this shipment has, so we may check for reservations
Declaration
public const string ShipmenttypeId = "shipmenttype_id"Field Value
| Type | Description |
|---|---|
| String |
SmtpPort
SShipment.SmtpPort: The port of the SMTP server to use for this shipment.
Declaration
public const string SmtpPort = "smtp_port"Field Value
| Type | Description |
|---|---|
| String |
SmtpServ
SShipment.SmtpServ: The server to use for this shipment.
Declaration
public const string SmtpServ = "smtp_serv"Field Value
| Type | Description |
|---|---|
| String |
SoftbounceNum
SShipment.SoftbounceNum: Number of soft bounces
Declaration
public const string SoftbounceNum = "softbounce_num"Field Value
| Type | Description |
|---|---|
| String |
SoftbounceRate
SShipment.SoftbounceRate: Soft bounce rate % (softbounce_num / number_transmitted)
Declaration
public const string SoftbounceRate = "softbounce_rate"Field Value
| Type | Description |
|---|---|
| String |
Sorting
SShipment.Sorting: Which sorting should be used on the document mailing recipient list, used when generating PDF
Declaration
public const string Sorting = "sorting"Field Value
| Type | Description |
|---|---|
| String |
SShipmentId
SShipment.SShipmentId: Primary key
Declaration
public const string SShipmentId = "id"Field Value
| Type | Description |
|---|---|
| String |
StartDate
SShipment.StartDate: The date and time when to start this shipment
Declaration
public const string StartDate = "start_date"Field Value
| Type | Description |
|---|---|
| String |
Status
SShipment.Status: Sending/stopped/failed etc.
Declaration
public const string Status = "status"Field Value
| Type | Description |
|---|---|
| String |
TicketCategory
SShipment.TicketCategory: The category of tickets created while sending out if any. -1 if no ticket should be created
Declaration
public const string TicketCategory = "ticket_category"Field Value
| Type | Description |
|---|---|
| String |
TicketOwner
SShipment.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 const string TicketOwner = "ticket_owner"Field Value
| Type | Description |
|---|---|
| String |
TotalbounceNum
SShipment.TotalbounceNum: Total number of bounces
Declaration
public const string TotalbounceNum = "totalbounce_num"Field Value
| Type | Description |
|---|---|
| String |
TotalbounceRate
SShipment.TotalbounceRate: Total bounce rate % (totalbounce_num / number_transmitted)
Declaration
public const string TotalbounceRate = "totalbounce_rate"Field Value
| Type | Description |
|---|---|
| String |
Updated
SShipment.Updated: Last updated when
Declaration
public const string Updated = "updated"Field Value
| Type | Description |
|---|---|
| String |
UpdatedAssociateId
SShipment.UpdatedAssociateId: Last updated by whom
Declaration
public const string UpdatedAssociateId = "updated_associate_id"Field Value
| Type | Description |
|---|---|
| String |
UpdatedCount
SShipment.UpdatedCount: Number of updates made to this record
Declaration
public const string UpdatedCount = "updatedCount"Field Value
| Type | Description |
|---|---|
| String |