IUnsubscriptionProvider Interface

Handles unsubscriptions.

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 9.0.0

Syntax

public interface IUnsubscriptionProvider

The IUnsubscriptionProvider type exposes the following members.

Methods

	Name	Description
Public method	CloneUnsubscriptionForEmail	Clones all unsubscriptions existing for the given email and set them to newEmail. Final state after execution of the method are two same unsubscriptions, one with the original email, one with the newEmail. This method should be used whenever subscriber changes their email and already has some unsubscription saved, so it can be assumed they want to have unsubscription for the newEmail as well.
Public method	GetUnsubscriptionsFromAllNewsletters	Returns query of all unsubscribed email addresses that won't receive any newsletter on given site. Is affected by UseSiteSpecificUnsubscriptions().
Public method	GetUnsubscriptionsFromSingleNewsletter	Returns query of all unsubscribed email addresses that won't receive given newsletter. Is affected by UseSiteSpecificUnsubscriptions().
Public method	IsUnsubscribedFromAllNewsletters	Returns true if specified email address is unsubscribed from the all newsletter on given site. Is affected by UseSiteSpecificUnsubscriptions().
Public method	IsUnsubscribedFromSingleNewsletter	Returns true if specified email address is unsubscribed from newsletter on given site. Is affected by UseSiteSpecificUnsubscriptions().
Public method	RemoveUnsubscriptionFromSingleNewsletter	Deletes all unsubscription records that blocks email from getting issues sent from given newsletter.
Public method	RemoveUnsubscriptionsFromAllNewsletters	Deletes all "unsubscription from all" records for the given email on given site. Is affected by UseSiteSpecificUnsubscriptions().
Public method	UnsubscribeFromAllNewsletters	Unsubscribes email address from all newsletters. Does nothing if specified email is already unsubscribed.
Public method	UnsubscribeFromSingleNewsletter	Unsubscribes email address from given newsletter. Does nothing if specified email is already unsubscribed.