EmailProvider Class

Extensible provider for basic e-mail capabilities that is used internally in the e-mail engine.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractBaseProvider<EmailProvider>
    CMS.EmailEngine.EmailProvider

Namespace: CMS.EmailEngine
Assembly: CMS.EmailEngine (in CMS.EmailEngine.dll) Version: 8.2.23

Syntax

public class EmailProvider : AbstractBaseProvider<EmailProvider>

The EmailProvider type exposes the following members.

Constructors

	Name	Description
Public method	EmailProvider

Methods

	Name	Description
Protected method	OnSendCompleted	Raises the SendCompleted event after the send is completed.
Protected method	SendEmailAsyncInternal	Internal method that asynchronously sends an e-mail through the SMTP server.
Protected method	SendEmailInternal	Internal method that sends an e-mail through the SMTP server.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Events

	Name	Description
Public event Static member	SendCompleted	Occurs when the send operation finishes.

Remarks

This provider does not offer any methods that can be called directly. To send e-mails using API, use methods from EmailSender class. Asynchronous send methods of this provider cannot be called from the main UI thread.