IEmailProvider Plugin Type

Ben Tiedt — Fri, 08 Mar 2024 17:11:00 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:11:00

IEmailProvider is defined in the Telligent.Evolution.Extensibility.Version1.Email namespace of Telligent.Evolution.Platform.dll

Definition

interface IEmailProvider : [[IPlugin Plugin Type|IPlugin]], [[ISingletonPlugin Plugin Type|ISingletonPlugin]]
{
	void Configure([[EmailConfigurationController Plugin Supplementary Type|EmailConfigurationController]] controller);
	Task<[[SendEmailResponse Plugin Supplementary Type|SendEmailResponse]]> SendAsync([[EmailMessage Plugin Supplementary Type|EmailMessage]] message, CancellationToken token);
}

Methods

void Configure(EmailConfigurationController controller);

Called after the plugin initializes to obtain the appropriate EmailConfigurationController for later use.

Parameters

Name	Type	Description	Required	Default	Options
controller	`[[EmailConfigurationController Plugin Supplementary Type\|EmailConfigurationController]]`	Controller	Required

Task<SendEmailResponse> SendAsync(EmailMessage message, CancellationToken token);

Called when the platform initiates the sending of an email.

Parameters

Name	Type	Description	Required	Default	Options
message	`[[EmailMessage Plugin Supplementary Type\|EmailMessage]]`	Message	Required
token	`CancellationToken`	Token	Required

Return Type

Task<[[SendEmailResponse Plugin Supplementary Type|SendEmailResponse]]>