Click or drag to resize
UnsubscriptionEventArgs Class
Event arguments for the UnsubscriptionHandler.
Inheritance Hierarchy

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 10.0.0
Syntax
C#
public class UnsubscriptionEventArgs : CMSEventArgs

The UnsubscriptionEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodUnsubscriptionEventArgs
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyEmail
Email address that is being unsubscribed.
Public propertyIssueID
ID of issue that subscriber used for unsubscription. Is present only when IssueID is known (is null for example when unsubscribing from administration UI or when issue was deleted).
Public propertyNewsletter
Newsletter that subscriber is unsubscribing from. Can be null in case that subscriber unsubscribed from all newsletter communication.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.)
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.)
Public methodCancel
Cancels the current handler execution
(Inherited from CMSEventArgs.)
Public methodDetectRecursion
Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false.
(Inherited from CMSEventArgs.)
Public methodDispose
Make sure the objects get disposed
(Inherited from CMSEventArgs.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Top
Extension Methods
  NameDescription
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
See Also