Views: 6402
Number of votes: 4
Average rating:

Implementing a simple email queue in EPiServer Commerce

Recently I’ve been working with a Commerce project where when a customer has placed an order we wanted to send a confirmation email. In the EPiServer Commerce sample site the code to send the confirmation email is in the code behind of the cart checkout control. This isn’t a good practice as if something goes wrong with the email sending, for example, if the SMTP configuration is incorrect, then the user will see an error saying something went wrong with their order, which in this case is not true.

What we decided to do was to queue up an email request using the EPiServer Dynamic Data Store and then use an EPiServer Scheduled Job to service the email queue and send out the emails.

First of all we created a simple class with the information needed to send the email:

using System;
using EPiServer.Data.Dynamic;

namespace Project.Foundation.CMS.Helpers
{   
    [EPiServerDataStore(AutomaticallyCreateStore = true)]
    public class OrderEmailToBeSent
    {
        public int OrderId { get; set; }
        public Guid Id { get; set; }
    }
}

Then when an order is placed we created an instance of the above class, set it’s properties and saved it in the DDS:

private void SaveOrderId(int orderId)
{
     var store = typeof(OrderEmailToBeSent).GetStore();
     var orderEmailToBeSent = new OrderEmailToBeSent { OrderId = orderId };
     store.Save(orderEmailToBeSent);
}

The Scheduled Job class gets the items from the Dynamic Data Store, loads the order from the Commerce system, sends an email to the customer, and then deletes the item from the DDS:

[ScheduledPlugIn(DisplayName = "Send order emails")]
 class SendOrderEmails
 {
     public static string Execute()
     {
         var store = typeof(OrderEmailToBeSent).GetStore();
         int skip = 0;
         const int count = 50;
         while (true)
         {
             var items = store.Items<OrderEmailToBeSent>().Skip(skip).Take(count);

             if (items.Count() == 0)
                 break;

             foreach (var orderEmailToBeSent in items)
             {
                 var order = CartHelper.FindOrder(orderEmailToBeSent.OrderId);

                 SendEmail(order, "order-purchaseorder-notify");
                 store.Delete(orderEmailToBeSent);
             }

             skip += count;
      }
         return "Success!";
     }
 }

And the code for sending the email:

private static void SendEmail(PurchaseOrder order, string template)
{
      // Add input parameter
      var dic = new Dictionary<string, object>();
      dic.Add("OrderGroup", order);

      // Execute template processor
      var body = TemplateService.Process(template,                  
Thread.CurrentThread.CurrentCulture, dic); // Send out emails var msg = new MailMessage(); msg.From = new MailAddress("store@yourcompany.com"); msg.To.Add(new MailAddress("customer@customer.com", " - " + order.Name)); msg.Subject = "Subject"; msg.Body = body; msg.IsBodyHtml = true; var client = new SmtpClient(); client.Send(msg); }

The TemplateService class used above takes an XSL template and transforms it into an HTML email. See this article for more details about this.

Jul 01, 2011

magnus
(By magnus, 7/1/2011 2:28:42 AM)

Awesome!!

dule
(By dule, 7/1/2011 7:59:52 AM)

Very nice!!!

Leif Boström
(By Leif Boström, 7/1/2011 10:35:45 AM)

Great post!

martin.soderlund
(By martin.soderlund, 7/1/2011 10:46:34 AM)

Super stuff! :-)

Jeff.Wallace
(By Jeff.Wallace, 7/1/2011 10:05:42 PM)

Good stuff. :)

Jeff.Wallace
(By Jeff.Wallace, 7/1/2011 10:05:45 PM)

Good stuff. :)

toni
(By toni, 7/2/2011 12:04:45 AM)

Clean and simple, I like it!

cecilia
(By cecilia, 7/2/2011 4:25:54 AM)

Thanks! Also thanks to Paul Smith for the idea.

steve
(By steve, 7/4/2011 3:26:26 PM)

Clever thinking. I guess this is a one language solution. In a multilang solution you probably want the email in the users locale, and should store the culture code in the queue too. The scheduler will run with the default locale (web.config)

jonas.bergqvist
(By jonas.bergqvist, 7/4/2011 7:09:46 PM)

Nice. One thing to think about is that the LINQ expression will be executed twice here. The "Count" will create and execute one LINQ expression against the database, and the foreach will create and execute another LINQ expression against the database.

In this case, it's maby what you want, but I just wanted to post a warning about it.

cecilia
(By cecilia, 7/4/2011 7:34:01 PM)

BQ, good point. I should set a flag in the foreach to indicate that there are items instead or use ToList() to convert the LINQ-query to a List.

Please login to comment.