Class MailFolderProvider
Provides list of subscribed and unsubscribed mail folders available for an account
Inheritance
System.Object
MailFolderProvider
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("MailFolder", 1073741823)]
public class MailFolderProvider : Object, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities, IPlugin
Constructors
MailFolderProvider()
Declaration
public MailFolderProvider()
Methods
Close()
Declaration
GetAvailableColumns()
Get a list of available columns for this provider
Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()
Returns
GetAvailableEntities()
Get available entities for this provider
Declaration
public List<ArchiveRowTypeInfo> GetAvailableEntities()
Returns
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 |
System.String |
options |
Options, passed to the internal GetRows method
|
Returns
Type |
Description |
System.Data.IDataReader |
IDataReader primed to provide results
|
Declaration
public virtual ArchiveResultInformation GetResultInformation()
Returns
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 |
System.String |
options |
|
Returns
Type |
Description |
System.Collections.Generic.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 |
System.String |
columnName |
Name of column to map
|
Returns
Type |
Description |
System.Int32 |
Database field id if available, otherwise 0
|
Remarks
MapDbIdToColumn(Int32)
Map an integer database field id to a qualified column name
Declaration
public string MapDbIdToColumn(int columnId)
Parameters
Type |
Name |
Description |
System.Int32 |
columnId |
Field id of column to map
|
Returns
Type |
Description |
System.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 |
System.String[] |
columnIds |
|
SetDesiredEntities(String[])
Declaration
public void SetDesiredEntities(params string[] entities)
Parameters
Type |
Name |
Description |
System.String[] |
entities |
|
SetOrderBy(ArchiveOrderByInfo[])
Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)
Parameters
SetPagingInfo(Int32, Int32)
Declaration
public void SetPagingInfo(int pageSize, int pageNumber)
Parameters
Type |
Name |
Description |
System.Int32 |
pageSize |
|
System.Int32 |
pageNumber |
|
SetRestriction(ArchiveRestrictionInfo[])
Set restrictions used to fetch desired columns/entities.
Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)