ISubscriptionService Interface

Handles all work with subscriptions and unsubscriptions.

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

Syntax

public interface ISubscriptionService

The ISubscriptionService type exposes the following members.

Methods

	Name	Description
Public method Code example	GetAllActiveSubscriptions	Method returns all subscriptions for given contact. Contact can be subscribed directly or using contact group. Only active subscriptions are retrieved (not approved one are omitted, unsubscriptions are reflected). Does not filter out subscriptions blocked using bounces.
Public method	IsSubscribed(Int32, Int32)	Returns true if subscriber is subscribed to given newsletter and at the same time is not in the unsubscription list for the given newsletter.
Public method	IsSubscribed(ContactInfo, NewsletterInfo)	Returns true if given contact is subscribed to given and at the same time is not in the unsubscription list for the given newsletter.
Public method	IsUnsubscribed	Returns true if specified email address is unsubscribed from newsletter.
Public method	RemoveSubscription	Unsubscribe the subscriber from the newsletter. Removes the binding from newsletter subscriber table.
Public method	Subscribe(ContactGroupInfo, NewsletterInfo)	Subscribes contact group to given newsletter.
Public method	Subscribe(Int32, Int32, SubscribeSettings)	Subscribes subscriber to given newsletter. Removes the email from unsubscription list for given newsletter. Whether or not email is removed from "unsubscribe form all" list can be specified in subscribeSettings parameter. subscribeSettings parameter specifies whether confirmation email will be send and if subscription should be approved immediately.
Public method	Subscribe(ContactInfo, NewsletterInfo, SubscribeSettings)	Subscribes contact to given newsletter. Removes the email from unsubscription list for given newsletter. Whether or not email is removed from "unsubscribe from all" list can be specified in subscribeSettings parameter. subscribeSettings parameter specifies whether confirmation email will be sent and if subscription should be approved immediately.
Public method	UnsubscribeFromAllNewsletters	Unsubscribes the email from all newsletters. SubscriberUnsubscribes event is invoked after unsubscribing. Binding in the newsletter-subscription table will stay. Email will be added into the unsubscription list.
Public method	UnsubscribeFromSingleNewsletter	Unsubscribes the email from newsletter. SubscriberUnsubscribes event is invoked after unsubscribing. Binding in the newsletter-subscription table will stay. Email will be added into the unsubscription list. Optionally, you can decide whether to send confirmation email.