alga
Sep 11, 2009
visibility 13490
star star star star star
(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

error Please login to comment.
Latest blogs
Finding Thomas Part 3 - The Moment of Recognition

Remember Thomas? In digital landscape, Thomas is the returning visitor who reads everything, opens every email, converts on nothing. In standard...

Ritu Madan | Jun 26, 2026

Add more scheduled job settings from the Optimizely CMS 12 admin UI -- with OptiScheduledJob.ExtraParameters

  Optimizely (EPiServer) CMS 12 ships a great scheduled-jobs framework, but it has one frustrating gap: a job has nowhere to store its own...

Binh Nguyen Thi | Jun 25, 2026

Automated Search & Navigation to Graph Migration with Claude Code

A Claude Code plugin that scans your S&N codebase, applies Graph SDK transformations, and validates the result. Install once, run one command. CMS ...

Connor Fortin | Jun 24, 2026

Migrating from Find to Graph: Lessons Learned from a Real CMS 13 Project

While migrating a search solution from Optimizely Search & Navigation (Find) to Optimizely Graph in CMS 13, I encountered several issues that were...

Binh Nguyen Thi | Jun 24, 2026