Mail.IMailClient Interface
Namespace: Nucleus.Abstractions.Mail
Assembly: Nucleus.Abstractions.dll
Allows Nucleus core and extensions to sent email using a configured email provider.
Remarks
Use Create to create an instance of this class.
Properties
SettingsPath Property
Generate a fully qualified path to the settings (cshtml) partial view for the mail client.
Remarks
Return null or an empty string if there is no settings view for the mail client.
Site Property
Specifies the Site that is using this instance.
Methods
GetSettings (Site) Method
GetSettings (Nucleus.Abstractions.Models.Site)
Return the extended settings type for the mail client.
Remarks
Return null if there is no settings view for the mail client.
Send<TModel> (MailTemplate, <TModel>, String) Method
Send<TModel> (MailTemplate template, <TModel> model, String to)
Parse the specified template, and send the resulting email to the specified to address.
Type Parameters
| TModel |
Parameters
| Name | Type |
|---|---|
| template | Nucleus.Abstractions.Models.Mail.MailTemplate |
| model | <TModel> |
| to | String |
SetSettings (Site, IMailSettings) Method
SetSettings (Nucleus.Abstractions.Models.Site, Nucleus.Abstractions.Mail.IMailSettings)
Return the settings type for the mail client.
Remarks
Return null if there is no settings view for the mail client.