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: 12.0.0

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.
Public method	SetAsDefaultProvider	Sets this object as the default provider (Inherited from AbstractBaseProvider<ProviderType>.)

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.