Class NewsletterSubscriberService
Provides operations for managing newsletter subscribers.
Inheritance
object
NewsletterSubscriberService
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Assembly: DataWeb.Core.dll
Syntax
public class NewsletterSubscriberService : INewsletterSubscriberService
Constructors
NewsletterSubscriberService(IConfigurationService, IDataProtectionProvider, INewsletterSubscriberStore, IHttpService, IEmailService, IHtmlService, ITemplateService, IStringLocalizer)
Initializes a new instance of the NewsletterSubscriberService class.
Declaration
public NewsletterSubscriberService(IConfigurationService configurationService, IDataProtectionProvider dataProtectionProvider, INewsletterSubscriberStore subscriberStore, IHttpService httpService, IEmailService emailService, IHtmlService htmlService, ITemplateService templateService, IStringLocalizer localizer)
Parameters
Properties
AppSettings
Gets the application settings.
Declaration
public ConfigurationAppSettings AppSettings { get; }
Property Value
Methods
ConfirmEmailAsync(NewsletterSubscriber, string)
Declaration
public Task<ConfirmEmailResult> ConfirmEmailAsync(NewsletterSubscriber subscriber, string code)
Parameters
Returns
ConvertStatus(string)
Converts the given value to a subscriber status.
Declaration
public SubscriberStatus ConvertStatus(string value)
Parameters
Type |
Name |
Description |
string |
value |
|
Returns
DeserializeAdditionalValues(string)
Deserializes the additional values of a subscriber.
Declaration
public List<NewsletterSubscriber.AdditionalValue> DeserializeAdditionalValues(string value)
Parameters
Type |
Name |
Description |
string |
value |
|
Returns
GenerateEmailConfirmationToken(NewsletterSubscriber)
Declaration
public string GenerateEmailConfirmationToken(NewsletterSubscriber subscriber)
Parameters
Returns
GetSMTPErrors()
Gets a list of SMTP errors.
Declaration
public List<List.ListItem> GetSMTPErrors()
Returns
GetSubscriberAsync(NewsletterSubscriberFilter)
Declaration
public Task<NewsletterSubscriber> GetSubscriberAsync(NewsletterSubscriberFilter filter)
Parameters
Returns
GetSubscriberCountAsync(NewsletterSubscriberFilter)
Declaration
public Task<long> GetSubscriberCountAsync(NewsletterSubscriberFilter filter)
Parameters
Returns
Type |
Description |
Task<long> |
|
GetSubscribersAsync(NewsletterSubscriberFilter)
Declaration
public Task<IEnumerable<NewsletterSubscriber>> GetSubscribersAsync(NewsletterSubscriberFilter filter)
Parameters
Returns
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
Returns
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)
Removes the subscriber with the given Id.
Declaration
public Task RemoveAsync(string id)
Parameters
Type |
Name |
Description |
string |
id |
|
Returns
RemoveGroupAsync(string, string)
Removes the given group from the subscriber.
Declaration
public Task RemoveGroupAsync(string subscriberId, string group)
Parameters
Type |
Name |
Description |
string |
subscriberId |
|
string |
group |
|
Returns
SendEmailConfirmAsync(NewsletterSubscriber, string)
Declaration
public Task SendEmailConfirmAsync(NewsletterSubscriber subscriber, string emailConfirmUrl)
Parameters
Returns
SerializeAdditionalValues(List<AdditionalValue>)
Serializes the additional values of a subscriber.
Declaration
public string SerializeAdditionalValues(List<NewsletterSubscriber.AdditionalValue> additionalValues)
Parameters
Returns
SetAsync(NewsletterSubscriber)
Declaration
public Task SetAsync(NewsletterSubscriber subscriber)
Parameters
Returns
SubscribeAsync(string, string, string, string, string, List<string>, List<string>, List<AdditionalValue>, bool, bool)
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)
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 |
|
Returns
UnsubscribeAsync(string)
Unsubscribes the email address from the newsletter.
Declaration
public Task<UnsubscribeResult> UnsubscribeAsync(string email)
Parameters
Type |
Name |
Description |
string |
email |
|
Returns
Implements