Skip to content

README.md

Latest commit

 

History

History
107 lines (76 loc) · 5.94 KB

README.md

File metadata and controls

107 lines (76 loc) · 5.94 KB

Email

Setup

The following sample binds settings from the configuration located in the section "Email" using SimpleInjector.

The settings contain sender Email and name, SMTP settings, Debug settings, PostProcessor settings and CSS settings. Check the EmailSettings class for details.

container.RegisterEmail(options => Configuration.GetSection("Email").Bind(options));

Razor Views (MVC)

Create and send an email

To add new emails, following steps need to be done:

  1. Add a new View (.cshtml) in the directory Views/Emails/.
  2. Add a new ViewModel in the same namespace as the business logic that needs to send the mail.
  3. Add the EmailView attribute to the ViewModel. The constructor argument is path to the view, relative to the Views directory without the .cshtml extension. Example: [EmailView("Emails/Registration")] points to Views/Emails/Registration.cshtml.
  4. Extend the EmailController with a new method to render the view file and return the contents.
  5. To send the mail in the business logic use the Mediator-command SendEmail and supply it with the view model. SendEmail renders the mail based on the view model and the EmailViewAttribute.

To check the visuals of the view file, use the Swagger API to access the methods of the EmailController.

View locations

The views that are used for the emails are configured on the EmailViewAttribute. To find the view, the Razor view engine looks in the folder Views by default. A view path of Emails/FancyEmail matches to Views/Emails/FancyEmail.cshtml.

If you want to place the Views in other folders, for example /Emails, you can simply configure this in the Razor options as follows:

services.Configure<RazorViewEngineOptions>(options => options.ViewLocationFormats.Add("/Emails/{0}" + RazorViewEngine.ViewExtension));

Set a Subject

Per default the SubjectKey is "Subject" and it is being tried to resolve from the corresponding resource file. If you want to use a different key, you can set it in the EmailViewAttribute like this: [EmailView("Emails/Registration", SubjectKey = "RegistrationSubject")]. If no value could be found it will fallback to the the SubjectKey.

Razor Components (Blazor)

Create and send an email

To add new emails, following steps need to be done:

  1. Add a new Component (.razor) in the directory Components/Emails/.
  2. Add a new ComponentModel in the same namespace as the business logic that needs to send the mail.
  3. Implement the IComponentModel<T> interface in the ComponentModel, where T is the type of the Component.
  4. Extend the EmailController with a new method to render the razor file and return the contents.
  5. To send the mail in the business logic use the Mediator-command SendEmail and supply it with the view model. SendEmail renders the mail based on the component model and the IComponentModel<T>.

To check the visuals of the view file, use the Swagger API to access the methods of the EmailController.

Component locations

In contrast to the classic Razor Views, the Razor Components can be placed in any folder, even in a different assembly, as long as you can reference it in the IComponentModel<T>.

Set a Subject

Per default the SubjectKey is "Subject" and it is being tried to resolve from the corresponding resource file. If you want to use a different key, you can optionally implement the IProvideEmailSubject interface like this string IProvideEmailSubject.SubjectKey => "RegistrationSubject";. If no value could be found it will fallback to the the SubjectKey.

Attachments

By default, only attachments in file://-Uris are supported. To allow adding attachments from other sources (eg. AWS S3), implement IEmailAttachmentResolver and register it SimpleInjector with

container.Collections.Append<IEmailAttachmentResolver, YourResolver>()

Headers

No special Headers are sent per default, however with the Headers parameter on SendEmail, MimeKit.Headers can be added to the email (overrides all Headers defined in EmailOptions.DefaultHeaders). With EmailOptions.DefaultHeaders default headers can be set for all emails. Predefined sets of headers can be found in EmailHeaders:

Post Processor

On the EmailOptions email content post processors can be defined on the RazorContentPostProcessor (.cshtml) and the BlazorContentPostProcessor (.razor) property. Per default they both call the CssInliner to inline all styles into the tags themselves. Providing null will instruct the renderer to not use a post processor.

Mjml Sample

Configuring the EmailOptions like seen in the sample below, all blazor emails will be processed by Mjml.Net before being sent.

container.RegisterSingleton<MjmlRenderer>();

container.RegisterEmail(o =>
{
    // Other configurations...

    o.BlazorContentPostProcessor = async ctx =>
    {
        var result = await container.GetInstance<MjmlRenderer>().RenderAsync(ctx.Html);

        return result.Html;
    };
});