Class NewsletterSubscriberService

Provides operations for managing newsletter subscribers.

Inheritance

object

NewsletterSubscriberService

Implements

INewsletterSubscriberService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Newsletter

Assembly: DataWeb.Core.dll

Syntax

public class NewsletterSubscriberService : INewsletterSubscriberService

Remarks

Initializes a new instance of the NewsletterSubscriberService class.

Constructors

NewsletterSubscriberService(IConfigurationService, IDataProtectionProvider, INewsletterSubscriberStore, IHttpService, IEmailService, IHtmlService, IRazorTemplateService, IStringLocalizer, TimeProvider)

Provides operations for managing newsletter subscribers.

Declaration

public NewsletterSubscriberService(IConfigurationService configurationService, IDataProtectionProvider dataProtectionProvider, INewsletterSubscriberStore subscriberStore, IHttpService httpService, IEmailService emailService, IHtmlService htmlService, IRazorTemplateService templateService, IStringLocalizer localizer, TimeProvider timeProvider)

Parameters

Type	Name	Description
IConfigurationService	configurationService	The configuration service.
IDataProtectionProvider	dataProtectionProvider	The data protection provider.
INewsletterSubscriberStore	subscriberStore	The subscriber store.
IHttpService	httpService	The HTTP service.
IEmailService	emailService	The email service.
IHtmlService	htmlService	The HTML service.
IRazorTemplateService	templateService	The template service.
IStringLocalizer	localizer	The string localizer.
TimeProvider	timeProvider

Remarks

Initializes a new instance of the NewsletterSubscriberService class.

Properties

AppSettings

Gets the application settings.

Declaration

public ConfigurationAppSettings AppSettings { get; }

Property Value

Type	Description
ConfigurationAppSettings

Methods

ConfirmEmailAsync(NewsletterSubscriber, string, CancellationToken)

Confirms the email address of the NewsletterSubscriber.

Declaration

public Task<ConfirmEmailResult> ConfirmEmailAsync(NewsletterSubscriber subscriber, string code, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriber	subscriber
string	code
CancellationToken	cancellationToken

Returns

Type	Description
Task<ConfirmEmailResult>

ConvertStatus(string)

Converts the given value to a subscriber status.

Declaration

public SubscriberStatus ConvertStatus(string value)

Parameters

Type	Name	Description
string	value

Returns

Type	Description
SubscriberStatus

DeserializeAdditionalValues(string)

Deserializes the additional values of a subscriber.

Declaration

public List<NewsletterSubscriber.AdditionalValue> DeserializeAdditionalValues(string value)

Parameters

Type	Name	Description
string	value

Returns

Type	Description
List<NewsletterSubscriber.AdditionalValue>

GenerateEmailConfirmationToken(NewsletterSubscriber)

Generates an email confirmation token for the NewsletterSubscriber.

Declaration

public string GenerateEmailConfirmationToken(NewsletterSubscriber subscriber)

Parameters

Type	Name	Description
NewsletterSubscriber	subscriber

Returns

Type	Description
string

GetSMTPErrors()

Gets a list of SMTP errors.

Declaration

public List<List.ListItem> GetSMTPErrors()

Returns

Type	Description
List<List.ListItem>

GetSubscriberAsync(NewsletterSubscriberFilter, CancellationToken)

Gets the subscriber that matches the given NewsletterSubscriberFilter.

Declaration

public Task<NewsletterSubscriber> GetSubscriberAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriberFilter	filter
CancellationToken	cancellationToken

Returns

Type	Description
Task<NewsletterSubscriber>

GetSubscriberCountAsync(NewsletterSubscriberFilter, CancellationToken)

Gets the number of subscribers that match the given NewsletterSubscriberFilter.

Declaration

public Task<long> GetSubscriberCountAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriberFilter	filter
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>

GetSubscribersAsync(NewsletterSubscriberFilter, CancellationToken)

Gets a list of subscribers that match the given NewsletterSubscriberFilter.

Declaration

public Task<IEnumerable<NewsletterSubscriber>> GetSubscribersAsync(NewsletterSubscriberFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriberFilter	filter
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<NewsletterSubscriber>>

MergeAdditionalValues(List<AdditionalValue>, List<AdditionalValue>)

Merges a list of existing additional values with a list of provided additional values.

Declaration

public List<NewsletterSubscriber.AdditionalValue> MergeAdditionalValues(List<NewsletterSubscriber.AdditionalValue> existingAdditionalValues, List<NewsletterSubscriber.AdditionalValue> providedAdditionalValues)

Parameters

Type	Name	Description
List<NewsletterSubscriber.AdditionalValue>	existingAdditionalValues
List<NewsletterSubscriber.AdditionalValue>	providedAdditionalValues

Returns

Type	Description
List<NewsletterSubscriber.AdditionalValue>

MergeStringValues(List<string>, List<string>)

Merges a list of existing string values with a list of provided string values.

Declaration

public List<string> MergeStringValues(List<string> existingValues, List<string> providedValues)

Parameters

Type	Name	Description
List<string>	existingValues
List<string>	providedValues

Returns

Type	Description
List<string>

RemoveAsync(string, CancellationToken)

Removes the subscriber with the given Id.

Declaration

public Task RemoveAsync(string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id
CancellationToken	cancellationToken

Returns

Type	Description
Task

RemoveGroupAsync(string, string, CancellationToken)

Removes the given group from the subscriber.

Declaration

public Task RemoveGroupAsync(string subscriberId, string group, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	subscriberId
string	group
CancellationToken	cancellationToken

Returns

Type	Description
Task

SendEmailConfirmAsync(NewsletterSubscriber, string, CancellationToken)

Sends an email confirmation to the NewsletterSubscriber.

Declaration

public Task SendEmailConfirmAsync(NewsletterSubscriber subscriber, string emailConfirmUrl, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriber	subscriber
string	emailConfirmUrl
CancellationToken	cancellationToken

Returns

Type	Description
Task

SerializeAdditionalValues(List<AdditionalValue>)

Serializes the additional values of a subscriber.

Declaration

public string SerializeAdditionalValues(List<NewsletterSubscriber.AdditionalValue> additionalValues)

Parameters

Type	Name	Description
List<NewsletterSubscriber.AdditionalValue>	additionalValues

Returns

Type	Description
string

SetAsync(NewsletterSubscriber, CancellationToken)

Sets the given NewsletterSubscriber.

Declaration

public Task SetAsync(NewsletterSubscriber subscriber, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterSubscriber	subscriber
CancellationToken	cancellationToken

Returns

Type	Description
Task

SubscribeAsync(string, string, string, string, string, List<string>, List<string>, List<AdditionalValue>, bool, bool, CancellationToken)

Subscribes a new email address to the newsletter.

Declaration

public Task<SubscribeResult> SubscribeAsync(string email, string culture, string source, string country = null, string zone = null, List<string> interests = null, List<string> groups = null, List<NewsletterSubscriber.AdditionalValue> additionalValues = null, bool isKeepStatus = false, bool isRequireConfirmedEmail = false, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	email
string	culture
string	source
string	country
string	zone
List<string>	interests
List<string>	groups
List<NewsletterSubscriber.AdditionalValue>	additionalValues
bool	isKeepStatus
bool	isRequireConfirmedEmail
CancellationToken	cancellationToken

Returns

Type	Description
Task<SubscribeResult>

UnsubscribeAsync(string, CancellationToken)

Unsubscribes the email address from the newsletter.

Declaration

public Task<UnsubscribeResult> UnsubscribeAsync(string email, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	email
CancellationToken	cancellationToken

Returns

Type	Description
Task<UnsubscribeResult>

Implements

INewsletterSubscriberService