Click or drag to resize
IUnsubscriptionProvider Interface
Handles unsubscriptions.

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 10.0.0
Syntax
C#
public interface IUnsubscriptionProvider

The IUnsubscriptionProvider type exposes the following members.

Methods
  NameDescription
Public methodCloneUnsubscriptionForEmail
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 methodGetUnsubscriptionsFromAllNewsletters
Returns query of all unsubscribed email addresses that won't receive any newsletter.
Public methodGetUnsubscriptionsFromSingleNewsletter
Returns query of all unsubscribed email addresses that won't receive given newsletter.
Public methodIsUnsubscribedFromAllNewsletters
Returns true if specified email address is unsubscribed from the all newsletter.
Public methodIsUnsubscribedFromSingleNewsletter
Returns true if specified email address is unsubscribed from newsletter.
Public methodRemoveUnsubscriptionFromSingleNewsletter
Deletes all unsubscription records that blocks email from getting issues sent from given newsletter.
Public methodRemoveUnsubscriptionsFromAllNewsletters
Deletes all "unsubscription from all" records for the given email.
Public methodUnsubscribeFromAllNewsletters
Unsubscribes email address from all newsletters. Does nothing if specified email is already unsubscribed.
Public methodUnsubscribeFromSingleNewsletter
Unsubscribes email address from given newsletter. Does nothing if specified email is already unsubscribed.
Top
See Also