alga
Sep 11, 2009
  13405
(1 votes)

Inserting an unsubscribe link into an HTML Template in EPiServerMail 4.4

In order to insert an unsubscribe link into an HTML template you can do as follows:

1) Looking at the contents of the EPiServerMail.config, you locate and copy the unsubscribeUrl value:

   1: <episerver.mail> 
   2: <sites>
   3: <site hostname="Default">
   4: <broker brokerName="" brokerHostname="episervermail.episerver.com" brokerIP="xxx.xxx.xx.xxx" />
   5: <editor defaultFromAddress="no-reply@example.com" defaultFromName="Example.com Mailing Service" goMailUrl="http://www.example.com/EPiServerMail/Public/GoMail.aspx" mailFromAddress="support@example.com" goMailImageUrl="http://www.example.com/EPiServerMail/Public/pixel.gif" encoding="iso-8859-1" editorWebServiceUrl="http://www.example.com/EPiServerMail/Public/EPiServerMailService.asmx" unsubscribeUrl="http://www.example.com/EPiServerMail/Public/Unsubscribe.aspx?rid=§recipientId§&mid=§messageId§" />
   6: <smtpServer name="smtp.example1.com" port="25" timeout="60" authMode="None" account="" password="" />
   7: </site>
   8: </sites>
   9: </episerver.mail> 

2) Then, you make a hyperlink out of the copied unsubscribeUrl value and insert it into the HTML template you have chosen.

<a href="http://www.example.com/EPiServerMail/Public/Unsubscribe.aspx?rid=§recipientId§&mid=§messageId§">Unsubscribe</a>

Additional Note) When EPiServerMail is accessing the HTML Template the remoteaddress value is the address of the CMS server.  This can be used to show/hide the unsubscribe link as necessary.

Final Note) Since EPiServer Mail 4.4 SP1 Hotfix 1, you can type §unsubscribeUrl§ in the href value instead of the value suggested above.

Disclaimer: Reasonable effort has been made by the author to ensure that the information provided here is accurate, however, no guarantees for the accuracy of information are made. You hold full responsibility for your actions - please remember to make a backup before making any changes.

Sep 11, 2009

Comments

May 22, 2013 09:26 AM

EpiServer Mail 7:
We had an issue when using the link: Avregistrera dig här.
This is probably because we changed the value of §unsubscribeUrl§ in the config file to our own custom unsubscribe URL.

However, using the url of our custom unsubscribe page instead of the §unsubscribeUrl§ worked well. Even though the two are technically identical.

Neil Perry
Neil Perry Nov 26, 2015 05:57 PM

I could not get unsubscribe to work using MVC based Razor templates e.g.

Unsubscribe

But they work ok in an .aspx template.

Are Razor .cshtml templates supported for Unsubscribe links

Please login to comment.
Latest blogs
Creating an admin tool - unused assets

Let's make an admin tool to clean unused assets and see how to extend your favorite CMS with custom tools and menues! We will build a tool step by...

Daniel Ovaska | Apr 15, 2026

Running Optimizely CMS on .NET 11 Preview

Learn how to run Optimizely CMS on the .NET 11 preview with a single-line change. Explore performance gains, PGO improvements, and future-proofing...

Stuart | Apr 15, 2026 |

Your Optimizely Opal Is Probably Burning Carbon It Doesn't Need To

Four patterns Optimizely practitioners could be getting wrong with Opal agents: inference levels, oversized tool responses, missing output...

Andy Blyth | Apr 15, 2026 |

Optimizely CMS 13: A Strategic Reset for Content, AI, and Composable Marketing

Optimizely CMS 13 is not just another version upgrade—it represents a deliberate shift toward a connected, AI-enabled, and API-driven content...

Augusto Davalos | Apr 14, 2026

The 74% Problem: Why Most Companies Are Getting AI Wrong

I’ve seen this before… The pattern. The rush, the excitement, the scramble to adopt something new before anyone has stopped to ask what problem it...

Mark Welland | Apr 14, 2026

Scheduled jobs with parameters

Scheduled jobs is an integral part of most Optimizely solution but the UI has, in my opinon, always been lacking in usability and features. Earlier...

Per Nergård (MVP) | Apr 14, 2026