Creating Hard Bounces for Sitecore Email Experience Manager in code

This week I’ve been working on integrating with a 3rd party API for when Sitecore Email Experience Manager receives a hard bounce from a contact’s email account.

Creating the processor for the <exm.recipientListManagement.add> pipeline is quite easy as per usual but mimicking a hard bounce isn’t as easy as I thought.

Over on Sitecore Slack, Pete Navarra had a good idea of sending an email to a hard bounced account like this stack overflow answer but that wasn’t an option for me as on my dev machine all the EXM emails are getting caught by my local Papercut SMTP server.

Luckily with a few messages to the rest of the team I’m working with, someone had already done this by building up a bounce message, encrypting the details and then passing it into a BouncedMessageHandler.

Here’s a snippet of code to do it:

IStringCipher stringCipher = 
  Factory.CreateObject("exmAuthenticatedCipher", true) as IStringCipher;

if (stringCipher != null)
{
    BouncedMessageHandler bouncedMessageHandler = 
      new BouncedMessageHandler(
    Factory.CreateObject("exm/bouncedMessagesTaskPool", true) 
       as ShortRunningTaskPool,
    Factory.CreateObject("exm/recipientListManagementTaskPool", true) 
       as ShortRunningTaskPool);

    Random random = new Random();
    string messageId = "5beff565-cccb-4a36-83ba-17f66872d770";
    string contactId = "0a53d8ce-77e1-4c30-a903-9f128535fa99";
    string emailAddress = "test@test.com";

    List<Bounce> bouncedMessages = new List<Bounce>
    {
        new Bounce
        {
            Id = random.Next().ToString(),
            BounceReason = "reason",
            BounceType = BounceStatus.HardBounce,
            CampaignId = "",
            ContactId = stringCipher.Encrypt(contactId),
            EmailAddress = emailAddress,
            MessageId = stringCipher.Encrypt(messageId)
        }
    };

    bouncedMessageHandler.HandleReportedMessages(bouncedMessages);
}

 

Creating Hard Bounces for Sitecore Email Experience Manager in code

Moving email campaigns between environments in Sitecore

I’ve been doing a lot of work with Email Experience Manager recently and when I’ve installed a package on the target environment containing the items for the campaign they don’t appear in the EXM interface even though they appear in the Sitecore tree.

One simple question over on the Sitecore Slack Channel and Steve McGill pointed me in the direction to get it fixed.

Once your items have been imported into your target environment you can go to the EXM admin page at {CMURL}/sitecore/admin/messagestatistics.aspx

exm-admin-page-sitecore

You then click on the Upgrade button it will find the newly imported emails and create a Sitecore SQL campaign record if it doesn’t exist already.

You will now see your imported campaigns in Email Experience Manager.

For automated messages that I am using, there also seems to be one final link between the Campaign Item and the Email Message Item that also needs to be connected in order for tracking to work. The one way to kick this in to gear is to open the message in EXM, click on the “Full email campaign” link, click on the “Delivery” tab and then click the “Deactivate” button and then once that completes, click on the “Activate Message” button and the link between the two items will be created.

 

Moving email campaigns between environments in Sitecore

Sitecore Data Provider Resources

I was recently given some work to improve a Sitecore Data Provider that connects into a 3rd party DAM system called WebDAM. My first port of call was the Sitecore documentation which was only slightly helpful in explaining the theory but not really any real world examples to help me. My issue was also being unable to start from scratch as there wasn’t time for that so I headed over to Google. I pretty much spent days trawling the results for help and thought I would post the most useful links that I found as I finished my work by combining code from all of these:

The one project I struggled to get a hold of was BitsOnTheRun by Nick Wesselman. I eventually found it on the old marketplace but thought I would upload it to my Github just in case somebody else was looking for it: https://github.com/RyanDurkin/sitecore-bits-on-the-run

Without the awesome Sitecore community I probably would have never completed the work so thanks to everyone in the links above and hopefully this post will help someone else in the community also.

Sitecore Data Provider Resources

Sitecore PowerShell script to list unused media items with a prompt for folder location

I was recently asked to produce a report of all the unused media items in Sitecore for a specific Region folder and if you have the PowerShell extensions installed then there is a great one in there called “Media items not used by content items”.

Unfortunately this takes a very long time to run if you have a huge amount of media items in your library and didn’t allow the end user to specify a folder which lead me to extend it a little bit.

By extending the original script by Michael West and adding a Read-Variable prompt it gives the end user more flexibility:

$result = Read-Variable -Parameters `
 @{ Name = "item"; Title="Analyse subitems of"; Tooltip="Folder you want to analyse."; Root="/sitecore/media library/"} `
 -Title "Find all media items that are not in use" -Width 600 -Height 200 `
 -OkButtonName "Proceed" -CancelButtonName "Abort"

Which displays like so:

sitecore powershell read item prompt

You then get a brilliant list view of the results once the script has finished which allows the end user to export as CSV, Excel etc

sitecore powershell script dialog report list

The full script can be found here: https://gist.github.com/RyanDurkin/992aaff199b706a3a7920d956055f529

Sitecore PowerShell script to list unused media items with a prompt for folder location