Class MailFolderProvider

Provides list of subscribed and unsubscribed mail folders available for an account

Inheritance
Object
MailFolderProvider
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("MailFolder", 1073741823)]
public class MailFolderProvider : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin

Constructors

MailFolderProvider()

Default constructor

Declaration
public MailFolderProvider()

Methods

Close()

Declaration
public void Close()

GetAvailableColumns()

Get a list of available columns for this provider

Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
Type Description
List<ArchiveColumnInfo>

GetAvailableEntities()

Get available entities for this provider

Declaration
public List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
Type Description
List<ArchiveRowTypeInfo>

GetReader(String)

Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access

Declaration
public virtual IDataReader GetReader(string options)
Parameters
Type Name Description
String options

Options, passed to the internal GetRows method
Returns
Type Description
IDataReader

IDataReader primed to provide results

GetResultInformation()

Declaration
public virtual ArchiveResultInformation GetResultInformation()
Returns
Type Description
ArchiveResultInformation

GetRows(String)

Iterator over all rows in the archive, suitable for a foreach access. It is typically implemented using the yield keyword.

Declaration
public IEnumerable<ArchiveRow> GetRows(string options)
Parameters
Type Name Description
String options
Returns
Type Description
IEnumerable<ArchiveRow>

MapColumnToDbId(String)

Map a named column (usually a restriction column) to a database field id.

Declaration
public int MapColumnToDbId(string columnName)
Parameters
Type Name Description
String columnName

Name of column to map
Returns
Type Description
Int32

Database field id if available, otherwise 0
Remarks

In some cases we may need to map a column of an archive list provider to a unique database field. This is mostly required in order to fetch and store search criteria, both for Dynamic Selections and for other kinds of searches. Columns that are not mappable through this interface cannot be saved and restored, and are therefore not available as criteria for search functions (dynamic selection)

MapDbIdToColumn(Int32)

Map an integer database field id to a qualified column name

Declaration
public string MapDbIdToColumn(int columnId)
Parameters
Type Name Description
Int32 columnId

Field id of column to map
Returns
Type Description
String

Name of column that matches the given field id, or a blank string if there is no match

SetDesiredColumns(String[])

Declaration
public void SetDesiredColumns(params string[] columnIds)
Parameters
Type Name Description
String[] columnIds

SetDesiredEntities(String[])

Declaration
public void SetDesiredEntities(params string[] entities)
Parameters
Type Name Description
String[] entities

SetOrderBy(ArchiveOrderByInfo[])

Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
Type Name Description
ArchiveOrderByInfo[] orderBy

SetPagingInfo(Int32, Int32)

Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type Name Description
Int32 pageSize
Int32 pageNumber

SetRestriction(ArchiveRestrictionInfo[])

Set restrictions used to fetch desired columns/entities.

Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Type Name Description
ArchiveRestrictionInfo[] restrictions
Returns
Type Description
Boolean

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)