Class OutboxRow
Outgoing emails with sending status and other info
Row Object for table 'outbox'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class OutboxRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) OutboxRow OutboxRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(OutboxRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the OutboxTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, OutboxTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Unique indexes on table Outbox are:
Index fields | Nested index class name |
---|
Constructors
OutboxRow(OutboxRow.OutboxRowIdxBase)
Constructor for the class taking an index as argument. Outgoing emails with sending status and other info
Declaration
protected OutboxRow(OutboxRow.OutboxRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
SuperOffice.CRM.Rows.OutboxRow.OutboxRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentCreated
Current value, see property Created.
Declaration
protected DateTime _currentCreated
Field Value
Type | Description |
---|---|
System.DateTime |
_currentFromEmail
Current value, see property FromEmail.
Declaration
protected string _currentFromEmail
Field Value
Type | Description |
---|---|
System.String |
_currentFromEnvelope
Current value, see property FromEnvelope.
Declaration
protected string _currentFromEnvelope
Field Value
Type | Description |
---|---|
System.String |
_currentLastError
Current value, see property LastError.
Declaration
protected string _currentLastError
Field Value
Type | Description |
---|---|
System.String |
_currentMailSize
Current value, see property MailSize.
Declaration
protected int _currentMailSize
Field Value
Type | Description |
---|---|
System.Int32 |
_currentMessageId
Current value, see property MessageId.
Declaration
protected int _currentMessageId
Field Value
Type | Description |
---|---|
System.Int32 |
_currentNextRetry
Current value, see property NextRetry.
Declaration
protected DateTime _currentNextRetry
Field Value
Type | Description |
---|---|
System.DateTime |
_currentOutboxId
Current value, see property OutboxId.
Declaration
protected int _currentOutboxId
Field Value
Type | Description |
---|---|
System.Int32 |
_currentPid
Current value, see property Pid.
Declaration
protected int _currentPid
Field Value
Type | Description |
---|---|
System.Int32 |
_currentRcpt
Current value, see property Rcpt.
Declaration
protected string _currentRcpt
Field Value
Type | Description |
---|---|
System.String |
_currentRetries
Current value, see property Retries.
Declaration
protected int _currentRetries
Field Value
Type | Description |
---|---|
System.Int32 |
_currentRfc822Content
Current value, see property Rfc822Content.
Declaration
protected string _currentRfc822Content
Field Value
Type | Description |
---|---|
System.String |
_currentStatus
Current value, see property Status.
Declaration
protected int _currentStatus
Field Value
Type | Description |
---|---|
System.Int32 |
_currentSubject
Current value, see property Subject.
Declaration
protected string _currentSubject
Field Value
Type | Description |
---|---|
System.String |
_currentTicketId
Current value, see property TicketId.
Declaration
protected int _currentTicketId
Field Value
Type | Description |
---|---|
System.Int32 |
_currentType
Current value, see property Type.
Declaration
protected short _currentType
Field Value
Type | Description |
---|---|
System.Int16 |
_persistedCreated
Persisted value, see property Created.
Declaration
protected DateTime _persistedCreated
Field Value
Type | Description |
---|---|
System.DateTime |
_persistedFromEmail
Persisted value, see property FromEmail.
Declaration
protected string _persistedFromEmail
Field Value
Type | Description |
---|---|
System.String |
_persistedFromEnvelope
Persisted value, see property FromEnvelope.
Declaration
protected string _persistedFromEnvelope
Field Value
Type | Description |
---|---|
System.String |
_persistedLastError
Persisted value, see property LastError.
Declaration
protected string _persistedLastError
Field Value
Type | Description |
---|---|
System.String |
_persistedMailSize
Persisted value, see property MailSize.
Declaration
protected int _persistedMailSize
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedMessageId
Persisted value, see property MessageId.
Declaration
protected int _persistedMessageId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedNextRetry
Persisted value, see property NextRetry.
Declaration
protected DateTime _persistedNextRetry
Field Value
Type | Description |
---|---|
System.DateTime |
_persistedOutboxId
Persisted value, see property OutboxId.
Declaration
protected int _persistedOutboxId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedPid
Persisted value, see property Pid.
Declaration
protected int _persistedPid
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedRcpt
Persisted value, see property Rcpt.
Declaration
protected string _persistedRcpt
Field Value
Type | Description |
---|---|
System.String |
_persistedRetries
Persisted value, see property Retries.
Declaration
protected int _persistedRetries
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedRfc822Content
Persisted value, see property Rfc822Content.
Declaration
protected string _persistedRfc822Content
Field Value
Type | Description |
---|---|
System.String |
_persistedStatus
Persisted value, see property Status.
Declaration
protected int _persistedStatus
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedSubject
Persisted value, see property Subject.
Declaration
protected string _persistedSubject
Field Value
Type | Description |
---|---|
System.String |
_persistedTicketId
Persisted value, see property TicketId.
Declaration
protected int _persistedTicketId
Field Value
Type | Description |
---|---|
System.Int32 |
_persistedType
Persisted value, see property Type.
Declaration
protected short _persistedType
Field Value
Type | Description |
---|---|
System.Int16 |
Properties
Created
.NET type: DateTime. When the mail was created
Declaration
public virtual DateTime Created { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
FromEmail
.NET type: string. Mail address of the sender
Declaration
public virtual string FromEmail { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
FromEnvelope
.NET type: string. Envelope (smtp) Mail address of the sender
Declaration
public virtual string FromEnvelope { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
InnerFieldValuePairs
The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name
of the field returned from the Fields property.
Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type | Description |
---|---|
ArgumentParameterCollection |
Overrides
InnerPrimaryKey
The primary key needed to decide which specific row to alter with the current sql-command.
Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type | Description |
---|---|
FieldInfo |
Overrides
InnerPrimaryKeyValue
The actual value the primary key must have.
Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type | Description |
---|---|
Parameter |
Overrides
IsDirty
Is the row dirty, e.g. been modified since the last time it was saved to the database.
Declaration
public override bool IsDirty { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
IsNew
Is this object new, meaning that it does not exist in the database.
Declaration
public override bool IsNew { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
Item[String]
Get or set a value based on the name of the field.
Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | Name of the field in the database |
Property Value
Type | Description |
---|---|
System.Object | Value of the field. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
LastError
.NET type: string. The last error reported when sending this message
Declaration
public virtual string LastError { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
MailSize
.NET type: int. The size of the mail in bytes
Declaration
public virtual int MailSize { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
MessageId
.NET type: int. The message.id this reference is connected to.
Declaration
public virtual int MessageId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
NextRetry
.NET type: DateTime. When is the next time we should try again?
Declaration
public virtual DateTime NextRetry { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
OutboxId
.NET type: int. Primary key
Declaration
public virtual int OutboxId { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: PK.
This field is the primary key and can only be read, never written.
This field is not protected by the Sentry system, and can always be read
OutboxTableInfo
Get the OutboxTableInfo object associated with the row.
Declaration
public OutboxTableInfo OutboxTableInfo { get; }
Property Value
Type | Description |
---|---|
OutboxTableInfo |
Pid
.NET type: int. The process id owning this message
Declaration
public virtual int Pid { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Rcpt
.NET type: string. A list of recipience
Declaration
public virtual string Rcpt { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Retries
.NET type: int. The number of times we have tried to send this mail
Declaration
public virtual int Retries { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Rfc822Content
.NET type: string. The content of the outgoing email as a string. Alternative to using outbox file
Declaration
public virtual string Rfc822Content { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Status
.NET type: int. Status enum
Declaration
public virtual int Status { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Subject
.NET type: string. Subject of the mail
Declaration
public virtual string Subject { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
TicketId
.NET type: int. The ticket.id this reference is connected to.
Declaration
public virtual int TicketId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Type
.NET type: short. Indicates if this is a SMS to be sent via WebServices or a normal email. 0 = email, 1 = sms
Declaration
public virtual short Type { get; set; }
Property Value
Type | Description |
---|---|
System.Int16 |
Remarks
Original type in dictionary: Enum.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Methods
CreateNew()
Create a new instance of the OutboxRow object. Outgoing emails with sending status and other info
Declaration
public static OutboxRow CreateNew()
Returns
Type | Description |
---|---|
OutboxRow | A new instance of the OutboxRow object. |
GetFromCustomSearch(OutboxRow.CustomSearch)
Create a new instance of the OutboxRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).
Declaration
public static OutboxRow GetFromCustomSearch(OutboxRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
OutboxRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
OutboxRow | A new instance of the OutboxRow object, reflecting the result of the query. |
GetFromIdxOutboxId(Int32)
Create a new instance of the OutboxRow object, by querying the database table via the index 'IDXOutboxId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static OutboxRow GetFromIdxOutboxId(int outboxId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | outboxId |
Returns
Type | Description |
---|---|
OutboxRow | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the Outbox table. Non-unique indexes have corresponding inner classes and methods in the OutboxRows collection, since they may return more than one row.
GetFromReader(SoDataReader, OutboxTableInfo)
Create a new instance of the OutboxRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Outgoing emails with sending status and other info
Declaration
public static OutboxRow GetFromReader(SoDataReader reader, OutboxTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
OutboxTableInfo | tableInfo | OutboxTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object. |
Returns
Type | Description |
---|---|
OutboxRow | A new instance of the OutboxRow object. |
GetPersistedFieldValue(FieldInfo)
Get the persisted value of a field.
Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
System.Object | Field value, such as an int, DateTime, string ... Null can be returned if the value is not known. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
InternalSetValue(String, Object)
Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | |
System.Object | value |
Overrides
IsPersistedFieldValueKnown(FieldInfo)
Check if the persisted value for a field is known.
Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
System.Boolean | True if the value is known and sentry permits read. |
Overrides
OnLoad(SoDataReader, TableInfo)
Fill the object with data returned from the database.
Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | Object holding the data returned from the database. |
TableInfo | tableInfo | The TableInfo used for the SELECT statement. |
Overrides
OnSave(BatchSave)
Add the object to the BatchSave list if it needs saving.
Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type | Name | Description |
---|---|---|
BatchSave | batchSave | Collection of objects to be saved within the transaction. |
Overrides
Remarks
Classes overriding this method should call it.
OnSaved(Boolean)
Method called after the save operation has been performed.
Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | bSucceeded | True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back) |
Overrides
Reset()
Reset the changes made on the object.
Declaration
protected override void Reset()
Overrides
Remarks
If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.
SetDefaults(DefaulterStrategy)
Set default values for the row.
Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type | Name | Description |
---|---|---|
DefaulterStrategy | strategy | Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle |
Overrides
SetPrimaryKey(Int32)
Set the primary key for the row.
Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | primaryKey | The new primary key for the row. |
Overrides
SetRowAsNew()
Declaration
public override void SetRowAsNew()
Overrides
ToString()
ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String |
Validate(RowValidator)
Validate this row.
Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type | Name | Description |
---|---|---|
RowValidator | rowValidator | RowValidator for inserting the result of the validation |