Class MailingEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for MailingEntity.
A mailing (shipment) — the run that sends a message to a set of recipients
Inheritance
object ←
Carrier ←
MailingEntity
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 MailingEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var mailingEntity = agent.GetMailingEntity( 123 );
Constructors
MailingEntity()
Default constructor - defaults any enum props to 0.
Properties
Configuration
This field indicates what kind of shipment this is.
Property Value
int
DeliveredNum
Number of mails sent minus bounces
Property Value
int
Description
Describes the shipment
Property Value
string
EndDate
Is set when this shipment is ended
Property Value
DateTime
EnvelopeFrom
Email address for the MTA envelope (where bounces are returned)
Property Value
string
FolderId
The folder which this shipment belongs to. -1 indicates that the shipment is on the root
Property Value
int
FromAddr
Email address to put in the From header of the messages
Property Value
string
MailingId
Primary key
Property Value
int
MessageId
The id of the message that is sent in this shipment
Property Value
int
ProjectId
Set if this shipment should be related to a Project
Property Value
int
Recipients
The total number of recipients to send message to.
Property Value
int
Registered
Registered when
Property Value
DateTime
RegisteredAssociateId
Registered by whom
Property Value
int
ReplyAddr
Email address to put in the Reply To: header of the messages
Property Value
string
SelectionId
Set if this shipment should be related to a Selection
Property Value
int
SentNum
Number of mails sent
Property Value
int
ShipmenttypeId
Id of subscriptionType that this shipment has, so we may check for reservations
Property Value
int
StartDate
The date and time when to start this shipment
Property Value
DateTime
Status
Sending/stopped/failed etc.
NULL if unknown enum value.
Property Value
ShipmentStatus?
See Also
MailingEntity.Status_String
Status_String
Sending/stopped/failed etc.
Raw string enum value.
Property Value
string
See Also
MailingEntity.Status
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
