Content Studio Web Content Management System
SystemObject
ContentStudio.Document.Subscription.EventHandlerSubscriptionEventHandlerBase
ContentStudio.Document.Subscription.EventHandlerMailSubscriptionHandler
ContentStudio.Document.Subscription.EventHandlerCSMailSubscriptionHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Top
Top
Top
Top
[This is preliminary documentation and is subject to change.]
Adds base functionality to a Subscription event handler that implements
mail sending functionality.
Inheritance Hierarchy
ContentStudio.Document.Subscription.EventHandlerSubscriptionEventHandlerBase
ContentStudio.Document.Subscription.EventHandlerMailSubscriptionHandler
ContentStudio.Document.Subscription.EventHandlerCSMailSubscriptionHandler
Namespace: ContentStudio.Document.Subscription.EventHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
The MailSubscriptionHandler type exposes the following members.
Constructors
Name | Description | |
---|---|---|
MailSubscriptionHandler |
Initializes a new instance of the MailSubscriptionHandler class.
|
Properties
Name | Description | |
---|---|---|
ConnectionId |
Gets or sets the connection id passed in to the
EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method.
(Inherited from SubscriptionEventHandlerBase.) | |
Content | Obsolete.
Gets the content passed in the content argument of the
EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method.
(Inherited from SubscriptionEventHandlerBase.) | |
Credentials |
Gets the credentials to use when communicating with the message server.
The data was passed in the content argument of the
EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method inc combination
with the xml passed in.
(Inherited from SubscriptionEventHandlerBase.) | |
EventId |
Gets the event identifier passed in to the
EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method.
(Inherited from SubscriptionEventHandlerBase.) | |
ExtendedProperties |
Gets or a collections of extended properties that was sent to the event handler.
(Inherited from SubscriptionEventHandlerBase.) | |
FailedCount |
Gets or sets the number of subscribers to whom a message was not sent for some reason.
(Inherited from SubscriptionEventHandlerBase.) | |
FailureRetryInterval |
Gets the interval that the handler should wait before it tries to resend a failed message.
| |
Logger |
Gets or sets the logger object that is used when logging to a syslog.
(Inherited from SubscriptionEventHandlerBase.) | |
MaxNumberOfAllowedFailedRecipients |
Gets or sets the max number of allowed failed recipients allowed before the event handler reports an error and stops.
| |
Message |
Gets the mail message to be sent out to a subscriber.
| |
MessageDocumentUrl |
Gets URL to the Content Studio document to send to subscribers.
| |
NumberOfFailedRecipients |
Gets the number of failed recipients during the mail sending operation.
| |
OriginalBody |
Gets the original body.
| |
OriginalHtmlBody |
Gets the original message body generated from the Content Studio message source document.
| |
Properties |
Gets the regular properties that was passed in to the event handler.
(Inherited from SubscriptionEventHandlerBase.) | |
RecipientFailRetryLimit |
Gets the maximum number of times that the event handler should try to resend a message to a client
when there is a non-fatal, temporary error.
| |
SendCount |
Gets or gets the number of sent messages.
(Inherited from SubscriptionEventHandlerBase.) | |
SessionId |
Gets the numeric value of the session used by the Service Manager when it communicates with Content Studio.
(Inherited from SubscriptionEventHandlerBase.) | |
SmptClient |
Gets a SMPT client to use when sending mail messages.
| |
SmtpFailureLimit |
Gets the number of SMTP failures that is accepted before the handler stops and reports an error.
| |
StatusText |
Gets the status text that is sent back to the Service Manager after that the event handler has finished.
For success this value can be "OK" or "Success". The status can also be an informative message that
should be logged in the Content Studio event log.
(Inherited from SubscriptionEventHandlerBase.) | |
Subscribers |
Gets or gets the number of found subscribers.
(Inherited from SubscriptionEventHandlerBase.) | |
SubscriptionTypeHandled |
Gets or sets the subscription type handled.
(Inherited from SubscriptionEventHandlerBase.) | |
TimeOut |
Gets or sets the time out passed in to the
EventHandler(Int32, Int32, String, String, ICSCredentialsContainer, Int32, String) method.
(Inherited from SubscriptionEventHandlerBase.) |
Methods
Name | Description | |
---|---|---|
CreateLogger |
Creates the logger object that logs events to its implementation of the
ISysLogWriter interface.
(Inherited from SubscriptionEventHandlerBase.) | |
CreateMessage |
When implemented in derived class creates a message to be sent out to subscribers.
This method gets called once from the event handler.
(Overrides SubscriptionEventHandlerBaseCreateMessage.) | |
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SubscriptionEventHandlerBase.) | |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
(Overrides SubscriptionEventHandlerBaseDispose(Boolean).) | |
Equals | (Inherited from Object.) | |
EventHandler |
Defines an asyncronous Content Studio event handler.
This method gets called by Content Studio Service Manager when it needs to handle
a subscription related event.
(Inherited from SubscriptionEventHandlerBase.) | |
Finalize |
Releases unmanaged resources and performs other cleanup operations before the
SubscriptionEventHandlerBase is reclaimed by garbage collection.
(Inherited from SubscriptionEventHandlerBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
ReadData |
Gets a list of subscribers that should receive messages.
(Inherited from SubscriptionEventHandlerBase.) | |
SendMessage |
Sends the message to the specified subscriber.
(Overrides SubscriptionEventHandlerBaseSendMessage(SubscriptionInformation).) | |
SetMailMessageContent |
Sets a new Html body an text body of a message.
| |
SetStatus |
Sets the status text that is sent back to the Service Manager after that the event handler has finished.
(Inherited from SubscriptionEventHandlerBase.) | |
ToString | (Inherited from Object.) | |
ValidateEvent |
When implemented in derived classes, checks if the the event passed in is valid for this
implementation.
(Overrides SubscriptionEventHandlerBaseValidateEvent(Int32).) | |
ValidateMessage |
Validates a message before it is sent to a single subscriber.
(Overrides SubscriptionEventHandlerBaseValidateMessage(SubscriptionInformation).) | |
ValidateSubscriber |
Validates the subscriber to see if he/she should receive the message.
(Overrides SubscriptionEventHandlerBaseValidateSubscriber(SubscriptionInformation).) | |
WriteToLog |
Writes a message to the logger provided that a logger exists.
(Inherited from SubscriptionEventHandlerBase.) |
Events
Name | Description | |
---|---|---|
Finished |
Occurs when the event handler has done its job.
(Inherited from SubscriptionEventHandlerBase.) | |
Initialized |
Occurs when the event handler has parsed and read all of the passed in even handler arguments
but before the actual job has started.
A developer can subscribe to this event to do private initialization specific to the current implementation.
(Inherited from SubscriptionEventHandlerBase.) |
See Also