RouteCollectionExtensions.MapOpenedEmailHandlerRoute Method

Note: This API is now obsolete.

Maps handler responsible for tracking opened emails to routeUrl.

Namespace: Kentico.Newsletters.Web.Mvc
Assembly: Kentico.OnlineMarketing.Web.Mvc (in Kentico.OnlineMarketing.Web.Mvc.dll) Version: 12.0.0

Syntax

[ObsoleteAttribute("Use Kentico.Newsletters.Web.Mvc.ApplicationBuilderExtensions.UseEmailTracking() to enable the email tracking feature. The handler route is registered automatically as part of the feature.")]
public static Route MapOpenedEmailHandlerRoute(
	this ExtensionPoint<RouteCollection> extensionPoint,
	string routeUrl = "CMSModules/Newsletters/CMSPages/Track.ashx"
)

Parameters

extensionPoint

Type: Kentico.Web.Mvc.ExtensionPoint<RouteCollection>
The object that provides extensibility for RouteCollection.

routeUrl (Optional)

Type: System.String
URL where handler responsible for tracking opened emails is mapped. See the remarks section when using non-default URL.

Return Value

Type: Route
Route where handler responsible for tracking opened emails is mapped.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ExtensionPoint<RouteCollection>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	extensionPoint is null.

Remarks

The Kentico administration application uses EmailTrackingLinkHelper to obtain tracking URLs when sending emails. When non-default URL for routeUrl is used, the GetOpenedEmailTrackingPageInternal(SiteInfo) method has to be customized accordingly.