NewsletterEvents Class

Newsletter events.

Inheritance Hierarchy

System.Object
  CMS.Newsletters.NewsletterEvents

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

Syntax

public class NewsletterEvents

The NewsletterEvents type exposes the following members.

Constructors

	Name	Description
Public method	NewsletterEvents

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	GeneratePreview	Event that is called when preview is being generated for a subscriber. Altering of preview content that is being displayed is available through PreviewHtml property. The event is triggered in GetPreviewHTML(IssueInfo, SubscriberInfo) method.
Public field Static member	GenerateQueueItems	Fired when issue is being sent in newsletter. If you cancel this event, e-mails won't be generated into newsletter queue (see EmailQueueItemInfo) and sent afterwards. You can use this event to manually add items to queue for your custom subscriber.
Public field Static member	ObtainSubscriberAddresses	Is called when newsletter module is asking other modules that have custom subscriber type (see SubscriberType property) for e-mail addresses that an issue will be sent to. The event arguments are a SubscriberInfo of the subscriber that the e-mails are being obtained and reference to a set of addresses. Handlers subscribing to this event should then check whether the subscriber is of required type and fill the given set of addresses with its own addresses.
Public field Static member	ResolveMacros	Fired when all newsletter text macros are being resolved. This includes: - resolving context-free macros for the whole issue before sending - resolving macros with Subscriber context for each recipient - resolving macros in the e-mail preview mode - when link tracking is enabled and tracking link is being changed to the original one, macros in original link are resolved - ...