Click or drag to resize
CMS.Newsletters Namespace
 
Classes
  ClassDescription
Public classABTestInfo
ABTestInfo data container class.
Public classABTestInfoProvider
Class providing ABTestInfo management.
Public classActivityTrackingHelper
Helper methods for logging activities for opened e-mails and link tracking.
Public classBounceChecker
Task for checking bounced newsletter e-mails.
Public classClickedLinkInfo
ClickedLinkInfo data container class.
Public classClickedLinkInfoProvider
Class providing ClickedLinkInfo management.
Public classDefaultIssueTextFilter
Default implementation for IIssueTextFilter.
Remarks
Filter firstly resolves macros. Secondly converts link to absolute. Adds utm parameters to all domain links. Then converts links to tracking links. Finally injects tracking image.
Public classDynamicNewsletterSender
Class used by scheduler to execute the dynamic newsletter mailout.
Public classEmailQueueItemInfo
Class representing newsletter queue item.
Public classEmailQueueItemInfoProvider
Class providing EmailQueueItemInfo management.
Public classEmailQueueManager
Manages generation and sending of EmailQueueItems (newsletter queue).
Public classEmailTemplateHelper
Helper class for e-mail template manipulation.
Public classEmailTemplateInfo
EmailTemplate data container class.
Public classEmailTemplateInfoProvider
Class providing EmailTemplate management.
Public classEmailTemplateNewsletterInfo
EmailTemplateNewsletterInfo data container class.
Public classEmailTemplateNewsletterInfoProvider
Class providing EmailTemplateNewsletterInfo management.
Public classEmailTemplateType
Email template type enumeration.
Public classGeneratePreviewEventArgs
Event arguments for GeneratePreviewHandler handler type.
Public classGeneratePreviewHandler
Handler for event GeneratePreview. Alteration of what is being displayed as a preview e-mail for a subscriber can be done through
Public classGenerateQueueItemsEventArgs
Event arguments for GenerateQueueItems event.
Public classGenerateQueueItemsHandler
Handler for GenerateQueueItems event.
Public classIssueABVariantItem
Class contains issue ID and variant name pair.
Public classIssueHelper
Issue helper class.
Public classIssueInfo
Issue data container class.
Public classIssueInfoProvider
Class providing Issue management.
Public classIssueSender
Class for sending newsletter issues (IssueInfo).
Public classLinkConverter
Converts links in newsletter issue text.
Public classLinkInfo
LinkInfo data container class.
Public classLinkInfoProvider
Class providing LinkInfoProvider management.
Public classLinksEventArgs
Event arguments for the LinksHandler
Public classLinksHandler
Handler raised when system link in email campaign is clicked and tracked, e.g. for logging email opening and email link tracking.
Public classLinkTracker
Tracks subscribers who clicked on a link in a newsletter issue.
Public classNewsletterConstants
Constants related to the newsletter module.
Public classNewsletterContext
Newsletter context.
Public classNewsletterEvents
Newsletter events.
Public classNewsletterHelper
Newsletter helper class.
Public classNewsletterInfo
Newsletter data container class.
Public classNewsletterInfoProvider
Class providing Newsletter management.
Public classNewsletterMacroMethods
Newsletter methods - wrapping methods for macro resolver.
Public classNewsletterModule
Represents the Newsletter module.
Public classNewsletterModuleMetadata
Represents the Newsletter module metadata.
Public classNewsletterResolvers
Resolvers used in e-mail templates and other macro visual components.
Public classNewsletterSender
Task for re-sending remaining newsletters in newsletter queue after main thread sender exit unexpectedly.
Public classNewsletterSubscriptionAction
Class for subscribe/unsubscribe contact to newsletter
Public classNewsletterTasksManager
Class for managing scheduled tasks that relate to newsletters (QueueSender).
Public classNewsletterType
Newsletter type enumeration.
Public classObtainSubscriberAddressesEventArgs
Event arguments for ObtainSubscriberAddressesHandler delegate type. It's used in ObtainSubscriberAddresses event. Its purpose is to resolve e-mail addresses for subscriber types that the newsletter module doesn't know about.
Public classObtainSubscriberAddressesHandler
Delegate type for ObtainSubscriberAddresses event. Its purpose is to resolve e-mail addresses for subscriber types that the newsletter module doesn't know about.
Public classOpenedEmailInfo
OpenedEmail data container class.
Public classOpenedEmailInfoProvider
Class providing OpenedEmailInfoProvider management.
Public classOpenEmailTracker
Tracks subscribers who opened a newsletter issues sent by e-mail.
Public classQueueSender
Scheduled task for newsletter issue mailout.
Public classResolveMacrosEventArgs
Event arguments for the ResolveMacrosHandler.
Public classResolveMacrosHandler
Handler for the event when macros are being resolved in the newsletter module.
Public classSendNewsletterIssueAction
Class for Send newsletter issue action
Public classSubscriberFullNameFormater
Class builds full name of subscribers of all existing types.
Public classSubscriberImporter
Manages importing subscribers into site newsletters.
Public classSubscriberInfo
Subscriber data container class.
Public classSubscriberInfoProvider
Class providing Subscriber management.
Public classSubscriberNewsletterInfo
SubscriberNewsletterInfo data container class.
Public classSubscriberNewsletterInfoProvider
Class providing SubscriberNewsletterInfo management.
Public classSubscribeSettings
Settings defining how exactly will Subscribe(Int32, Int32, SubscribeSettings) method behave.
Public classThreadEmailSender
Async e-mail sender. Gets e-mails from newsletter queue, prepares them and sends them to e-mail queue.
Public classUnsubscriptionEventArgs
Event arguments for the UnsubscriptionHandler.
Public classUnsubscriptionHandler
Handler for the event when subscriber email is being unsubscribed.
Public classUnsubscriptionInfo
Container for unsubscription data. Contains email unsubscribed from newsletter and site. Interpretation of data is affected by NewslettersConfiguration, setting "CMSNewsletterUseSiteSpecificUnsubscriptions". If false, having null in the newsletter ID column means unsubscribed from all newsletters on all sites. Otherwise unsubscribed from all newsletters only on specific site.
Public classUnsubscriptionInfoProvider
Class providing access to unsubscriptions. Interpretation of data is affected by NewslettersConfiguration, setting "CMSNewsletterUseSiteSpecificUnsubscriptions". If false, having null in the newsletter ID column means unsubscribed from all newsletters on all sites. Otherwise unsubscribed from all newsletters only on specific site.
Public classVariantEventArgs
Additional arguments for variant slider and variant dialog events.
Public classWinnerSelection
Scheduled task - selects the best issue variant and sends it to subscribers.
Interfaces
  InterfaceDescription
Public interfaceIEmailAddressBlocker
Provides methods which decide whether email to certain email address should or should not be generated to the newsletter queue.
Public interfaceIEmailHashValidator
Provides method for validating hash generated from given email address.
Public interfaceIIssueSender
Class for sending newsletter issues (IssueInfo).
Public interfaceIIssueTextFilter
Issue text filter is used for transforming the content of issue (issue text, subject, etc.).
Public interfaceINewslettersConfiguration
Provides access to settings used in newsletters module.
Public interfaceISubscriberEmailRetriever
Class for retrieving subscriber email address.
Public interfaceISubscriberFullNameFormater
Provides methods for building full name of subscribers of all existing types.
Public interfaceISubscriberUserProvider
Provides method for linking the subscriber with the related user.
Public interfaceISubscriptionApprovalService
Approves subscription by provided hash.
Public interfaceISubscriptionHashValidator
Validates subscription hash.
Public interfaceISubscriptionService
Handles all work with subscriptions and unsubscriptions.
Public interfaceIUnsubscriptionProvider
Handles unsubscriptions.
Delegates
  DelegateDescription
Public delegateBounceChecker.FallbackDecoderHandler
Occurs when a character set name could not be mapped to the encoding.
Enumerations
  EnumerationDescription
Public enumerationABTestWinnerSelectionEnum
Winner option enumeration
Public enumerationApprovalResult
Subscription approval result.
Public enumerationHashValidationResult
Hash validation result.
Public enumerationIssueStatusEnum
Issue status enumeration