SoundInTheory.Piranha.Emails 1.0.0

Piranha Emails

Module that simplifies the sending of emails, including the management of email templates.

This module is still in development and not recommended for public use.

Key Features

• Customisable email templates that can be edited directly in Piranha
• MJML and Handlebars Templating to make designing and editing emails easy.
• Handlebars lets you place complex methods behind a single tag
• You can also customise the subject line with Handlebars
• Configurable senders that work with both SMTP and Mailgun
• Support for sample data and previewing with multiple sample sets
• A test email sender

Usage

Set up Email Sender in appsettings.json. SMTP or Mailgun is currently supported.

{
 "PiranhaEmails": {
 "Senders": {
 "TestSender": {
 "FromEmail": "example@example.com",
 "FromName": "Mr Example",
 "SendToWhiteList": [],
 "SmtpSettings": {
 "SmtpUser": "example@example.com",
 "SmtpPassword": "password",
 "SmtpServer": "smtp.gmail.com",
 "SmtpPort": 465,
 "UseSsl": true,
 "RequiresAuthentication": true
 },
 //or
 "MailgunSettings": {
 "MailgunSendingKey": "sendingkeyhere",
 "MailgunDomain": "domain.example",
 "MailgunRegion": "USAorEU"
 }
 } 
 }
 }
}

Set up Email Template

[EmailTemplate(enabled: true)]
public class ResetPasswordTemplate : EmailTemplateInfo
{
 public new const string Key = "ResetPasswordEmail";

 public ResetPasswordTemplate()
 {
 Title = "Reset Password Email";
 
 //View model can be anything that ineherits EmailViewModel
 SampleData = new ResetPasswordEmailViewModel()
 {
 ResetLink = "http://www.exampleresetpassword.com/",
 };

 }
}

Add emails on startup

builder.AddPiranha(options => 
{
 //other services here

 options.Services.AddPiranhaEmails(builder)
 .AddEmailTemplates(typeof(MyWebsite).Assembly);//reference assembly with email
})

app.UsePiranha(options => {
 //other services here

 options.UsePiranhaEmails();
})

The template should be visible in the manager. Edit as required.

To send, use GenericEmailHandler

var contactUsTemplateInfo = _services.GetKeyedService<EmailTemplateInfo>("ContactUsEmail");
var contactUs = await _emailTemplateResolver.ResolveAsync("ContactUsEmail");

//DI'ed GenericEmailHandler
_emailHandler.Send(
 contactUs.Template.EmailSenderKey,
 toAddress,
 contactUs.Template.SubjectLine,
 contactUs.Template.Content,
 new ContactFormViewModel(){
 Form = etc
 }
);