Skip to content

Added support for mailgun templates #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/Senders/FluentEmail.Mailgun/IFluentEmailExtensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
using System.Threading.Tasks;
using FluentEmail.Core;
using FluentEmail.Core.Models;

namespace FluentEmail.Mailgun
{
public static class IFluentEmailExtensions
{
public static async Task<SendResponse> SendWithTemplateAsync(this IFluentEmail email, string templateName, object templateData)
{
var mailgunSender = email.Sender as IMailgunSender;
return await mailgunSender.SendWithTemplateAsync(email, templateName, templateData);
}
}
}
21 changes: 21 additions & 0 deletions src/Senders/FluentEmail.Mailgun/IMailgunSender.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
using System.Threading;
using System.Threading.Tasks;
using FluentEmail.Core;
using FluentEmail.Core.Interfaces;
using FluentEmail.Core.Models;

namespace FluentEmail.Mailgun;

public interface IMailgunSender : ISender
{
/// <summary>
/// Mailgun specific extension method that allows you to use a template instead of a message body.
/// For more information, see: https://documentation.mailgun.com/en/latest/api-sending.html#sending.
/// </summary>
/// <param name="email">Fluent email.</param>
/// <param name="templateName">Mailgun template name.</param>
/// <param name="templateData">Mailgun template data.</param>
/// <param name="token">Optional cancellation token.</param>
/// <returns>A SendResponse object.</returns>
Task<SendResponse> SendWithTemplateAsync(IFluentEmail email, string templateName, object templateData, CancellationToken? token = null);
}
109 changes: 73 additions & 36 deletions src/Senders/FluentEmail.Mailgun/MailgunSender.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@
using FluentEmail.Core.Interfaces;
using FluentEmail.Core.Models;
using FluentEmail.Mailgun.HttpHelpers;
using Newtonsoft.Json;

namespace FluentEmail.Mailgun
{
public class MailgunSender : ISender
public class MailgunSender : IMailgunSender
{
private readonly string _apiKey;
private readonly string _domainName;
Expand Down Expand Up @@ -51,46 +52,39 @@ public SendResponse Send(IFluentEmail email, CancellationToken? token = null)

public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken? token = null)
{
var parameters = new List<KeyValuePair<string, string>>();

parameters.Add(new KeyValuePair<string, string>("from", $"{email.Data.FromAddress.Name} <{email.Data.FromAddress.EmailAddress}>"));
email.Data.ToAddresses.ForEach(x => {
parameters.Add(new KeyValuePair<string, string>("to", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.CcAddresses.ForEach(x => {
parameters.Add(new KeyValuePair<string, string>("cc", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.BccAddresses.ForEach(x => {
parameters.Add(new KeyValuePair<string, string>("bcc", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.ReplyToAddresses.ForEach(x => {
parameters.Add(new KeyValuePair<string, string>("h:Reply-To", $"{x.Name} <{x.EmailAddress}>"));
});
parameters.Add(new KeyValuePair<string, string>("subject", email.Data.Subject));

var parameters = BuildMailgunParameters(email);

parameters.Add(new KeyValuePair<string, string>(email.Data.IsHtml ? "html" : "text", email.Data.Body));

if (!string.IsNullOrEmpty(email.Data.PlaintextAlternativeBody))
{
parameters.Add(new KeyValuePair<string, string>("text", email.Data.PlaintextAlternativeBody));
}

var files = BuildMailgunFiles(email);

email.Data.Tags.ForEach(x =>
{
parameters.Add(new KeyValuePair<string, string>("o:tag", x));
});
return await SendAsync(parameters, files, token);
}

foreach (var emailHeader in email.Data.Headers)
{
var key = emailHeader.Key;
if (!key.StartsWith("h:"))
{
key = "h:" + emailHeader.Key;
}
private async Task<SendResponse> SendAsync(List<KeyValuePair<string, string>> parameters, List<HttpFile> files, CancellationToken? token = null)
{
token?.ThrowIfCancellationRequested();

var response = await _httpClient.PostMultipart<MailgunResponse>("messages", parameters, files)
.ConfigureAwait(false);

parameters.Add(new KeyValuePair<string, string>(key, emailHeader.Value));
var result = new SendResponse {MessageId = response.Data?.Id};
if (!response.Success)
{
result.ErrorMessages.AddRange(response.Errors.Select(x => x.ErrorMessage));
return result;
}

return result;
}

private static List<HttpFile> BuildMailgunFiles(IFluentEmail email)
{
var files = new List<HttpFile>();
email.Data.Attachments.ForEach(x =>
{
Expand All @@ -109,17 +103,60 @@ public async Task<SendResponse> SendAsync(IFluentEmail email, CancellationToken?
ContentType = x.ContentType
});
});
return files;
}

private static List<KeyValuePair<string, string>> BuildMailgunParameters(IFluentEmail email)
{
var parameters = new List<KeyValuePair<string, string>>();

parameters.Add(new KeyValuePair<string, string>("from",
$"{email.Data.FromAddress.Name} <{email.Data.FromAddress.EmailAddress}>"));

email.Data.ToAddresses.ForEach(x =>
{
parameters.Add(new KeyValuePair<string, string>("to", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.CcAddresses.ForEach(x =>
{
parameters.Add(new KeyValuePair<string, string>("cc", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.BccAddresses.ForEach(x =>
{
parameters.Add(new KeyValuePair<string, string>("bcc", $"{x.Name} <{x.EmailAddress}>"));
});
email.Data.ReplyToAddresses.ForEach(x =>
{
parameters.Add(new KeyValuePair<string, string>("h:Reply-To", $"{x.Name} <{x.EmailAddress}>"));
});
parameters.Add(new KeyValuePair<string, string>("subject", email.Data.Subject));

var response = await _httpClient.PostMultipart<MailgunResponse>("messages", parameters, files).ConfigureAwait(false);
email.Data.Tags.ForEach(x => { parameters.Add(new KeyValuePair<string, string>("o:tag", x)); });

var result = new SendResponse {MessageId = response.Data?.Id};
if (!response.Success)
foreach (var emailHeader in email.Data.Headers)
{
result.ErrorMessages.AddRange(response.Errors.Select(x => x.ErrorMessage));
return result;
var key = emailHeader.Key;
if (!key.StartsWith("h:"))
{
key = "h:" + emailHeader.Key;
}

parameters.Add(new KeyValuePair<string, string>(key, emailHeader.Value));
}

return parameters;
}

return result;
public async Task<SendResponse> SendWithTemplateAsync(IFluentEmail email, string templateName, object templateData,
CancellationToken? token = null)
{
var parameters = BuildMailgunParameters(email);
var files = BuildMailgunFiles(email);

parameters.Add(new KeyValuePair<string, string>("template", templateName));
parameters.Add(new KeyValuePair<string, string>("h:X-Mailgun-Variables", JsonConvert.SerializeObject(templateData)));

return await SendAsync(parameters, files, token);
}
}
}
13 changes: 13 additions & 0 deletions test/FluentEmail.Core.Tests/MailgunSenderTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,19 @@ public async Task CanSendEmailWithInlineImages()
Assert.IsTrue(response.Successful);
}
}

// [Test]
// public async Task CanSendEmailWithTemplate()
// {
// var email = Email
// .From(fromEmail)
// .To(toEmail)
// .Subject(subject);
//
// var response = await email.SendWithTemplateAsync("test-template", new { var1 = "Test" });
//
// Assert.IsTrue(response.Successful);
// }

class Variable
{
Expand Down