Show / Hide Table of Contents

Class MailInFilterRow

This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP).
Row Object for table 'mail_in_filter'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
MailInFilterRow
Implements
INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem
Inherited Members
TableRowBase._saveOwner
TableRowBase._sentries
TableRowBase._onValueChange
TableRowBase._relatedNestedPersistMembers
TableRowBase._sqlType
TableRowBase.InternalSetValue(Int32, Object)
TableRowBase.InternalSetValue(SoField, Object)
TableRowBase.GetFieldValue(FieldInfo)
TableRowBase.GetKnownFields()
TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)
TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)
TableRowBase.IsGhostField(FieldInfo)
TableRowBase.RowLoad()
TableRowBase.RowLoad(ITableRowLoadHandler)
TableRowBase.OnLoaded(IdxBase)
TableRowBase.Load(IdxBase, SoDataReader)
TableRowBase.Load(SoDataReader, TableInfo)
TableRowBase.SetDefaults()
TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)
TableRowBase.SetSaveOwner(INestedPersist)
TableRowBase.Save()
TableRowBase.Delete()
TableRowBase.Validate()
TableRowBase.SetDirty(Int32, Object, Object)
TableRowBase.INestedPersist.OnPreIdUpdate()
TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)
TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.INestedPersist.OnIdUpdate()
TableRowBase.INestedPersist.OnSave(BatchSave)
TableRowBase.INestedPersist.OnSaved(Boolean)
TableRowBase.OnPreIdUpdate()
TableRowBase.OnPrimaryKeyRequest(PKContainer)
TableRowBase.OnPrimaryKeyUpdate(PKContainer)
TableRowBase.OnIdUpdate()
TableRowBase.BeginIgnoreSentryCheck()
TableRowBase.EndIgnoreSentryCheck()
TableRowBase.GetRelatedNestedPersist()
TableRowBase.Item[Int32]
TableRowBase.Item[SoField]
TableRowBase.Sentries
TableRowBase.ForeignKeyHelper
TableRowBase.IsDeleted
TableRowBase.IsSaving
TableRowBase.SqlType
TableRowBase.IsSentryIgnored
TableRowBase.IsMarkedForDelete
TableRowBase.OnValueChanged
TableRowBase.OnElementSaved
TableRowBase.OnElementIdUpdate
PrivateSave.GetTableInfos()
PrivateSave.CloneToBasicUpdatingQuery()
PrivateSave.OnUpdateField
SqlCommand.Origin
SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)
SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)
SqlCommand.ClearIgnoreAutoSentryTableInfos()
SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)
SqlCommand.GetPrivateSaves()
SqlCommand.GetInserts()
SqlCommand.GetUpdates()
SqlCommand.GetDeletes()
SqlCommand.GetSelect()
SqlCommand.AutoSentryIgnoredTables
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 MailInFilterRow : 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) MailInFilterRow MailInFilterRow.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(MailInFilterRow.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 MailInFilterTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, MailInFilterTableInfo) 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.
Non-unique indexes are handled through the MailInFilterRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, MailInFilterTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table MailInFilter are:

Index fieldsNested index class name

Constructors

MailInFilterRow(MailInFilterRow.MailInFilterRowIdxBase)

Constructor for the class taking an index as argument. This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP).

Declaration
protected MailInFilterRow(MailInFilterRow.MailInFilterRowIdxBase idx)
Parameters
Type Name Description
MailInFilterRow.MailInFilterRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAddress

Current value, see property Address.

Declaration
protected string _currentAddress
Field Value
Type Description
String

_currentAutofaq

Current value, see property Autofaq.

Declaration
protected short _currentAutofaq
Field Value
Type Description
Int16

_currentAutofaqKbCategory

Current value, see property AutofaqKbCategory.

Declaration
protected int _currentAutofaqKbCategory
Field Value
Type Description
Int32

_currentCategoryId

Current value, see property CategoryId.

Declaration
protected int _currentCategoryId
Field Value
Type Description
Int32

_currentCheckwait

Current value, see property Checkwait.

Declaration
protected int _currentCheckwait
Field Value
Type Description
Int32

_currentDomain

Current value, see property Domain.

Declaration
protected string _currentDomain
Field Value
Type Description
String

_currentImportmailPid

Current value, see property ImportmailPid.

Declaration
protected int _currentImportmailPid
Field Value
Type Description
Int32

_currentKeepHeaders

Current value, see property KeepHeaders.

Declaration
protected string _currentKeepHeaders
Field Value
Type Description
String

_currentLanguageId

Current value, see property LanguageId.

Declaration
protected int _currentLanguageId
Field Value
Type Description
Int32

_currentLastError

Current value, see property LastError.

Declaration
protected string _currentLastError
Field Value
Type Description
String

_currentLastSuccess

Current value, see property LastSuccess.

Declaration
protected DateTime _currentLastSuccess
Field Value
Type Description
DateTime

_currentLastTry

Current value, see property LastTry.

Declaration
protected DateTime _currentLastTry
Field Value
Type Description
DateTime

_currentMailgunDsn

Current value, see property MailgunDsn.

Declaration
protected short _currentMailgunDsn
Field Value
Type Description
Int16

_currentMailInFilterId

Current value, see property MailInFilterId.

Declaration
protected int _currentMailInFilterId
Field Value
Type Description
Int32

_currentNextCheck

Current value, see property NextCheck.

Declaration
protected DateTime _currentNextCheck
Field Value
Type Description
DateTime

_currentNoautoreply

Current value, see property Noautoreply.

Declaration
protected short _currentNoautoreply
Field Value
Type Description
Int16

_currentNumSeqFailures

Current value, see property NumSeqFailures.

Declaration
protected int _currentNumSeqFailures
Field Value
Type Description
Int32

_currentPopPassword

Current value, see property PopPassword.

Declaration
protected string _currentPopPassword
Field Value
Type Description
String

_currentPopServer

Current value, see property PopServer.

Declaration
protected string _currentPopServer
Field Value
Type Description
String

_currentPopUser

Current value, see property PopUser.

Declaration
protected string _currentPopUser
Field Value
Type Description
String

_currentPriority

Current value, see property Priority.

Declaration
protected int _currentPriority
Field Value
Type Description
Int32

_currentReplyTemplateId

Current value, see property ReplyTemplateId.

Declaration
protected int _currentReplyTemplateId
Field Value
Type Description
Int32

_currentServerType

Current value, see property ServerType.

Declaration
protected MailboxType _currentServerType
Field Value
Type Description
MailboxType

_currentStatus

Current value, see property Status.

Declaration
protected short _currentStatus
Field Value
Type Description
Int16

_persistedAddress

Persisted value, see property Address.

Declaration
protected string _persistedAddress
Field Value
Type Description
String

_persistedAutofaq

Persisted value, see property Autofaq.

Declaration
protected short _persistedAutofaq
Field Value
Type Description
Int16

_persistedAutofaqKbCategory

Persisted value, see property AutofaqKbCategory.

Declaration
protected int _persistedAutofaqKbCategory
Field Value
Type Description
Int32

_persistedCategoryId

Persisted value, see property CategoryId.

Declaration
protected int _persistedCategoryId
Field Value
Type Description
Int32

_persistedCheckwait

Persisted value, see property Checkwait.

Declaration
protected int _persistedCheckwait
Field Value
Type Description
Int32

_persistedDomain

Persisted value, see property Domain.

Declaration
protected string _persistedDomain
Field Value
Type Description
String

_persistedImportmailPid

Persisted value, see property ImportmailPid.

Declaration
protected int _persistedImportmailPid
Field Value
Type Description
Int32

_persistedKeepHeaders

Persisted value, see property KeepHeaders.

Declaration
protected string _persistedKeepHeaders
Field Value
Type Description
String

_persistedLanguageId

Persisted value, see property LanguageId.

Declaration
protected int _persistedLanguageId
Field Value
Type Description
Int32

_persistedLastError

Persisted value, see property LastError.

Declaration
protected string _persistedLastError
Field Value
Type Description
String

_persistedLastSuccess

Persisted value, see property LastSuccess.

Declaration
protected DateTime _persistedLastSuccess
Field Value
Type Description
DateTime

_persistedLastTry

Persisted value, see property LastTry.

Declaration
protected DateTime _persistedLastTry
Field Value
Type Description
DateTime

_persistedMailgunDsn

Persisted value, see property MailgunDsn.

Declaration
protected short _persistedMailgunDsn
Field Value
Type Description
Int16

_persistedMailInFilterId

Persisted value, see property MailInFilterId.

Declaration
protected int _persistedMailInFilterId
Field Value
Type Description
Int32

_persistedNextCheck

Persisted value, see property NextCheck.

Declaration
protected DateTime _persistedNextCheck
Field Value
Type Description
DateTime

_persistedNoautoreply

Persisted value, see property Noautoreply.

Declaration
protected short _persistedNoautoreply
Field Value
Type Description
Int16

_persistedNumSeqFailures

Persisted value, see property NumSeqFailures.

Declaration
protected int _persistedNumSeqFailures
Field Value
Type Description
Int32

_persistedPopPassword

Persisted value, see property PopPassword.

Declaration
protected string _persistedPopPassword
Field Value
Type Description
String

_persistedPopServer

Persisted value, see property PopServer.

Declaration
protected string _persistedPopServer
Field Value
Type Description
String

_persistedPopUser

Persisted value, see property PopUser.

Declaration
protected string _persistedPopUser
Field Value
Type Description
String

_persistedPriority

Persisted value, see property Priority.

Declaration
protected int _persistedPriority
Field Value
Type Description
Int32

_persistedReplyTemplateId

Persisted value, see property ReplyTemplateId.

Declaration
protected int _persistedReplyTemplateId
Field Value
Type Description
Int32

_persistedServerType

Persisted value, see property ServerType.

Declaration
protected MailboxType _persistedServerType
Field Value
Type Description
MailboxType

_persistedStatus

Persisted value, see property Status.

Declaration
protected short _persistedStatus
Field Value
Type Description
Int16

Properties

Address

.NET type: string. The address associated with this mailbox (used as FROM: address when sending emails).

Declaration
public virtual string Address { get; set; }
Property Value
Type Description
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

Autofaq

.NET type: short. Whether to suggest FAQ entries for this email account or not

Declaration
public virtual short Autofaq { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

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

AutofaqKbCategory

.NET type: int. The root folder for the auto faq search.

Declaration
public virtual int AutofaqKbCategory { get; set; }
Property Value
Type Description
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

CategoryId

.NET type: int. The id of the category this mailbox assigns tickets to (unless overridden by a sortfilter).

Declaration
public virtual int CategoryId { get; set; }
Property Value
Type Description
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

Checkwait

.NET type: int. How often (in minutes) to check this mailbox.

Declaration
public virtual int Checkwait { get; set; }
Property Value
Type Description
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

Domain

.NET type: string. The domain used to login.

Declaration
public virtual string Domain { get; set; }
Property Value
Type Description
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

ImportmailPid

.NET type: int. The process id of the importMail instance processing this mailbox

Declaration
public virtual int ImportmailPid { get; set; }
Property Value
Type Description
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

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
PrivateSave.InnerFieldValuePairs

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
PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides
PrivateSave.InnerPrimaryKeyValue

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
Boolean
Overrides
TableRowBase.IsDirty

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides
TableRowBase.IsNew

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
String fieldName

Name of the field in the database

Property Value
Type Description
Object

Value of the field.

Overrides
TableRowBase.Item[String]
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

KeepHeaders

.NET type: string. A commaseparated list of headers to store for emails imported. E.g. 'to,from,recieved-by,subject'.

Declaration
public virtual string KeepHeaders { get; set; }
Property Value
Type Description
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

LanguageId

.NET type: int. The id of the customer language entry this entry is connected to.

Declaration
public virtual int LanguageId { get; set; }
Property Value
Type Description
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

LastError

.NET type: string. The last error message recieved from the underlying email system (such as POP3 protocol errors, etc).

Declaration
public virtual string LastError { get; set; }
Property Value
Type Description
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

LastSuccess

.NET type: DateTime. Datetime indicating the last time email was sucessfully imported from this mailbox. Used to display warnings when this value is getting too old.

Declaration
public virtual DateTime LastSuccess { get; set; }
Property Value
Type Description
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

LastTry

.NET type: DateTime. Datetime indicating the last time this mailbox tried (but possibly failed) to fetch email.

Declaration
public virtual DateTime LastTry { get; set; }
Property Value
Type Description
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

MailgunDsn

.NET type: short. If this is set to 1, the route created in Mailgun will be set up to deliver emails of type auto-replies, system messsages etc

Declaration
public virtual short MailgunDsn { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

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

MailInFilterId

.NET type: int. The primary key (auto-incremented)

Declaration
public virtual int MailInFilterId { get; }
Property Value
Type Description
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

MailInFilterTableInfo

Get the MailInFilterTableInfo object associated with the row.

Declaration
public MailInFilterTableInfo MailInFilterTableInfo { get; }
Property Value
Type Description
MailInFilterTableInfo

NextCheck

.NET type: DateTime. When this mailbox should be checked the next time.

Declaration
public virtual DateTime NextCheck { get; set; }
Property Value
Type Description
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

Noautoreply

.NET type: short. If set, then this mailbox should not send an autoreply.

Declaration
public virtual short Noautoreply { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

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

NumSeqFailures

.NET type: int. The number of sequential failures for this mailbox.

Declaration
public virtual int NumSeqFailures { get; set; }
Property Value
Type Description
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

PopPassword

.NET type: string. The password used to login.

Declaration
public virtual string PopPassword { get; set; }
Property Value
Type Description
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

PopServer

.NET type: string. The hostname/IP address of the server.

Declaration
public virtual string PopServer { get; set; }
Property Value
Type Description
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

PopUser

.NET type: string. The username used to login.

Declaration
public virtual string PopUser { get; set; }
Property Value
Type Description
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

Priority

.NET type: int. The id of the priority tickets are assigned when imported from this mailbox.

Declaration
public virtual int Priority { get; set; }
Property Value
Type Description
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

ReplyTemplateId

.NET type: int. ID of the reply template used on this mail box.

Declaration
public virtual int ReplyTemplateId { get; set; }
Property Value
Type Description
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

ServerType

.NET type: MailboxType. Enum indicating the protocol to use (POP/IMAP).

Declaration
public virtual MailboxType ServerType { get; set; }
Property Value
Type Description
MailboxType
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

Status

.NET type: short. Status indicated whether this mailbox is deleted or not.

Declaration
public virtual short Status { get; set; }
Property Value
Type Description
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

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.

Overrides
TableRowBase.TableInfo

Methods

CreateNew()

Create a new instance of the MailInFilterRow object. This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP).

Declaration
public static MailInFilterRow CreateNew()
Returns
Type Description
MailInFilterRow

A new instance of the MailInFilterRow object.

GetFromCustomSearch(MailInFilterRow.CustomSearch)

Create a new instance of the MailInFilterRow 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 MailInFilterRow GetFromCustomSearch(MailInFilterRow.CustomSearch query)
Parameters
Type Name Description
MailInFilterRow.CustomSearch query

The custom search to execute against the database

Returns
Type Description
MailInFilterRow

A new instance of the MailInFilterRow object, reflecting the result of the query.

GetFromIdxMailInFilterId(Int32)

Create a new instance of the MailInFilterRow object, by querying the database table via the index 'IDXMail_in_filterId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static MailInFilterRow GetFromIdxMailInFilterId(int mailInFilterId)
Parameters
Type Name Description
Int32 mailInFilterId
Returns
Type Description
MailInFilterRow

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 MailInFilter table. Non-unique indexes have corresponding inner classes and methods in the MailInFilterRows collection, since they may return more than one row.

GetFromReader(SoDataReader, MailInFilterTableInfo)

Create a new instance of the MailInFilterRow 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. This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP).

Declaration
public static MailInFilterRow GetFromReader(SoDataReader reader, MailInFilterTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

MailInFilterTableInfo tableInfo

MailInFilterTableInfo 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
MailInFilterRow

A new instance of the MailInFilterRow 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
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.

Overrides
PrivateSave.GetPersistedFieldValue(FieldInfo)
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
String fieldName
Object value
Overrides
TableRowBase.InternalSetValue(String, Object)

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
Boolean

True if the value is known and sentry permits read.

Overrides
PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

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
TableRowBase.OnLoad(SoDataReader, TableInfo)

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
TableRowBase.OnSave(BatchSave)
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
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
TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
TableRowBase.Reset()
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
TableRowBase.SetDefaults(DefaulterStrategy)

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.

Overrides
TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides
TableRowBase.SetRowAsNew()

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
String
Overrides
Object.ToString()

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

Overrides
TableRowBase.Validate(RowValidator)

Events

_onAddressChange

Change envent for property Address; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onAddressChange
Event Type
Type Description
OnFieldChange<String>

_onAutofaqChange

Change envent for property Autofaq; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onAutofaqChange
Event Type
Type Description
OnFieldChange<Int16>

_onAutofaqKbCategoryChange

Change envent for property AutofaqKbCategory; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onAutofaqKbCategoryChange
Event Type
Type Description
OnFieldChange<Int32>

_onCategoryIdChange

Change envent for property CategoryId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onCategoryIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onCheckwaitChange

Change envent for property Checkwait; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onCheckwaitChange
Event Type
Type Description
OnFieldChange<Int32>

_onDomainChange

Change envent for property Domain; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onDomainChange
Event Type
Type Description
OnFieldChange<String>

_onImportmailPidChange

Change envent for property ImportmailPid; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onImportmailPidChange
Event Type
Type Description
OnFieldChange<Int32>

_onKeepHeadersChange

Change envent for property KeepHeaders; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onKeepHeadersChange
Event Type
Type Description
OnFieldChange<String>

_onLanguageIdChange

Change envent for property LanguageId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onLanguageIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onLastErrorChange

Change envent for property LastError; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onLastErrorChange
Event Type
Type Description
OnFieldChange<String>

_onLastSuccessChange

Change envent for property LastSuccess; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastSuccessChange
Event Type
Type Description
OnFieldChange<DateTime>

_onLastTryChange

Change envent for property LastTry; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastTryChange
Event Type
Type Description
OnFieldChange<DateTime>

_onMailgunDsnChange

Change envent for property MailgunDsn; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onMailgunDsnChange
Event Type
Type Description
OnFieldChange<Int16>

_onNextCheckChange

Change envent for property NextCheck; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onNextCheckChange
Event Type
Type Description
OnFieldChange<DateTime>

_onNoautoreplyChange

Change envent for property Noautoreply; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onNoautoreplyChange
Event Type
Type Description
OnFieldChange<Int16>

_onNumSeqFailuresChange

Change envent for property NumSeqFailures; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onNumSeqFailuresChange
Event Type
Type Description
OnFieldChange<Int32>

_onPopPasswordChange

Change envent for property PopPassword; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onPopPasswordChange
Event Type
Type Description
OnFieldChange<String>

_onPopServerChange

Change envent for property PopServer; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onPopServerChange
Event Type
Type Description
OnFieldChange<String>

_onPopUserChange

Change envent for property PopUser; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onPopUserChange
Event Type
Type Description
OnFieldChange<String>

_onPriorityChange

Change envent for property Priority; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onPriorityChange
Event Type
Type Description
OnFieldChange<Int32>

_onReplyTemplateIdChange

Change envent for property ReplyTemplateId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onReplyTemplateIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onServerTypeChange

Change envent for property ServerType; field is of .NET type short.

Declaration
protected event OnFieldChange<MailboxType> _onServerTypeChange
Event Type
Type Description
OnFieldChange<MailboxType>

_onStatusChange

Change envent for property Status; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onStatusChange
Event Type
Type Description
OnFieldChange<Int16>

OnAddressChange

Event raised when Address is changing.

Declaration
public event OnFieldChange<string> OnAddressChange
Event Type
Type Description
OnFieldChange<String>

OnAutofaqChange

Event raised when Autofaq is changing.

Declaration
public event OnFieldChange<short> OnAutofaqChange
Event Type
Type Description
OnFieldChange<Int16>

OnAutofaqKbCategoryChange

Event raised when AutofaqKbCategory is changing.

Declaration
public event OnFieldChange<int> OnAutofaqKbCategoryChange
Event Type
Type Description
OnFieldChange<Int32>

OnCategoryIdChange

Event raised when CategoryId is changing.

Declaration
public event OnFieldChange<int> OnCategoryIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnCheckwaitChange

Event raised when Checkwait is changing.

Declaration
public event OnFieldChange<int> OnCheckwaitChange
Event Type
Type Description
OnFieldChange<Int32>

OnDomainChange

Event raised when Domain is changing.

Declaration
public event OnFieldChange<string> OnDomainChange
Event Type
Type Description
OnFieldChange<String>

OnImportmailPidChange

Event raised when ImportmailPid is changing.

Declaration
public event OnFieldChange<int> OnImportmailPidChange
Event Type
Type Description
OnFieldChange<Int32>

OnKeepHeadersChange

Event raised when KeepHeaders is changing.

Declaration
public event OnFieldChange<string> OnKeepHeadersChange
Event Type
Type Description
OnFieldChange<String>

OnLanguageIdChange

Event raised when LanguageId is changing.

Declaration
public event OnFieldChange<int> OnLanguageIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnLastErrorChange

Event raised when LastError is changing.

Declaration
public event OnFieldChange<string> OnLastErrorChange
Event Type
Type Description
OnFieldChange<String>

OnLastSuccessChange

Event raised when LastSuccess is changing.

Declaration
public event OnFieldChange<DateTime> OnLastSuccessChange
Event Type
Type Description
OnFieldChange<DateTime>

OnLastTryChange

Event raised when LastTry is changing.

Declaration
public event OnFieldChange<DateTime> OnLastTryChange
Event Type
Type Description
OnFieldChange<DateTime>

OnMailgunDsnChange

Event raised when MailgunDsn is changing.

Declaration
public event OnFieldChange<short> OnMailgunDsnChange
Event Type
Type Description
OnFieldChange<Int16>

OnNextCheckChange

Event raised when NextCheck is changing.

Declaration
public event OnFieldChange<DateTime> OnNextCheckChange
Event Type
Type Description
OnFieldChange<DateTime>

OnNoautoreplyChange

Event raised when Noautoreply is changing.

Declaration
public event OnFieldChange<short> OnNoautoreplyChange
Event Type
Type Description
OnFieldChange<Int16>

OnNumSeqFailuresChange

Event raised when NumSeqFailures is changing.

Declaration
public event OnFieldChange<int> OnNumSeqFailuresChange
Event Type
Type Description
OnFieldChange<Int32>

OnPopPasswordChange

Event raised when PopPassword is changing.

Declaration
public event OnFieldChange<string> OnPopPasswordChange
Event Type
Type Description
OnFieldChange<String>

OnPopServerChange

Event raised when PopServer is changing.

Declaration
public event OnFieldChange<string> OnPopServerChange
Event Type
Type Description
OnFieldChange<String>

OnPopUserChange

Event raised when PopUser is changing.

Declaration
public event OnFieldChange<string> OnPopUserChange
Event Type
Type Description
OnFieldChange<String>

OnPriorityChange

Event raised when Priority is changing.

Declaration
public event OnFieldChange<int> OnPriorityChange
Event Type
Type Description
OnFieldChange<Int32>

OnReplyTemplateIdChange

Event raised when ReplyTemplateId is changing.

Declaration
public event OnFieldChange<int> OnReplyTemplateIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnServerTypeChange

Event raised when ServerType is changing.

Declaration
public event OnFieldChange<MailboxType> OnServerTypeChange
Event Type
Type Description
OnFieldChange<MailboxType>

OnStatusChange

Event raised when Status is changing.

Declaration
public event OnFieldChange<short> OnStatusChange
Event Type
Type Description
OnFieldChange<Int16>

Implements

INestedPersist
ISoDataLookup
ISentryIgnorable
ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)
QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)
QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)
QueryExectionExtensions.ExecuteNonQuery(SqlCommand)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top