EmailInfoProvider MembersKentico 8.1 API Reference
The EmailInfoProvider type exposes the following members.
Constructors

  NameDescription
Public methodEmailInfoProvider
Back to Top
Methods

  NameDescription
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberBindEmailAttachment
Add attachment to specified e-mail and return its info object.
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodCreateWebFarmTask(String, String,  Byte )
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodStatic memberDeleteAll
Deletes all EmailInfo objects with specific parameters.
Public methodStatic memberDeleteAllFailed
Deletes all EmailInfo objects which sending has failed.
Public methodStatic memberDeleteArchived
Deletes expired archived e-mails.
Protected methodDeleteData(String)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodDeleteData(IWhereCondition)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodDeleteData(Action ObjectQuery TInfo  )
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberDeleteEmailInfo(Int32)
Deletes specified email.
Public methodStatic memberDeleteEmailInfo(EmailInfo)
Deletes specified email.
Protected methodDeleteEmailInfoInternal
Deletes specified email.
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodStatic memberFetchEmails
Fetches e-mails which should be sent and marks them as being sent.
Public methodStatic memberFetchMassEmail
Fetches mass e-mail which should be sent and marks it as being sent.
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodGetBindingWhereCondition(String,  Object )
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32 , Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDataByColumn T 
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDataByGuidColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDataByIntColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDataByStringColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberGetEmailCount
Gets number of e-mails due to where condition.
Public methodStatic memberGetEmailCountForSites
Gets dataset with two columns 'EmailSiteID' and 'EmailCount'. Dataset contains emails grouped by sites ID.
Public methodStatic memberGetEmailInfo
Returns the EmailInfo structure for the specified email ID.
Protected methodGetEmailInfoInternal
Returns the EmailInfo structure for the specified email ID.
Public methodStatic memberGetEmailInfos(String, String)
Returns all EmailInfo objects specified by where condition.
Public methodStatic memberGetEmailInfos(String, String, Int32, String)
Returns all EmailInfo objects specified by where condition.
Protected methodGetEmailsInternal
Returns all EmailInfo objects specified by where condition.
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberGetExpiredEmailCount
Gets the number of archived emails that are older that expiration date for each site.
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfo(Action ObjectQuery TInfo  )
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Int32, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByCodeNameFromDB
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByFullName(String)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByFullName(String, Boolean)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByFullNameInternal
Gets the info by its full name from the database
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuid(Guid)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuid(Guid, Int32)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuidColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByGuidFromDB
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoById(Int32)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoById(Int32, Boolean)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByIntColumn
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfoByStringColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberGetLastSetRelatedIDObsolete.
Gets last related ID from e-mail set defined by set name.
Public methodStatic memberGetMailMessage
Creates new System.Net.Mail.MailMessage from EmailInfo.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberGetPreviousNext
Returns the previous and next e-mails of the given e-mail in the order specified by ORDER BY parameter matching the WHERE criteria.
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodGetSiteWhereCondition(Int32)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodGetSiteWhereCondition(Int32, Boolean)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberChangeEmailSetStatus
Changes status of all e-mails in the specified set.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodInit
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitHashtables
Initializes the hashtable settings
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodLoadGeneration
Loads the specified generation of the objects.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodLoadObjectsToHashtables
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodNewTransaction
Creates a new transaction over this provider
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Protected methodRecalculateData
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Initializes the provider variables.
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodReplaceData
Replaces the data in the given columns.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodStatic memberResetSendingStatus
Resets e-mail's status to 'waiting' anywhere the status is 'sending'. Runs the action within a new thread.
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProvider TProvider .)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProvider TProvider .)
Public methodStatic memberSetEmailInfo(EmailInfo)
Sets (updates or inserts) specified email.
Public methodStatic memberSetEmailInfo(EmailMessage, Int32)
Creates new EmailInfo from EmailMessage.
Public methodStatic memberSetEmailInfo(EmailMessage, Int32, Boolean, Boolean)
Creates new EmailInfo from EmailMessage.
Public methodStatic memberSetEmailInfo(EmailMessage, Int32, Boolean, String, Int32)
Creates new EmailInfo from EmailMessage.
Protected methodSetEmailInfoInternal
Sets (updates or inserts) specified email.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodUpdateData
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodUseSource( TInfo )
Sets the provider to use given data as data source
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public methodUseSource(DataQuerySource)
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Protected fieldmTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Back to Top
Properties

  NameDescription
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Protected propertyGenerationColumnObsolete.
Column used to filter the data according the generation in which the items should be loaded.
(Inherited from BaseAbstractInfoProvider.)
Public propertyHashtableSettings
Hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Protected propertyLoadHashtablesObsolete.
Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Public propertyStoreEmptyValuesInHashtables
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProvider TInfo, TProvider .)
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseFullNameHashtableObsolete.
If true, the full name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseGUIDHashtableObsolete.
If true, the guid hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseHashtablesObsolete.
If true, the provider uses hashtables.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseIDHashtableObsolete.
If true, the ID hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseNameHashtableObsolete.
If true, the code name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseWeakReferencesObsolete.
If true, the weak references are used for the items so the memory can be cleared upon request
(Inherited from BaseAbstractInfoProvider.)
Back to Top
See Also