C# Class GSF.Historian.Notifiers.EmailNotifier

Represents a notifier that can send notifications in email messages.
Inheritance: GSF.Historian.Notifiers.NotifierBase
Show file Open project: GridProtectionAlliance/gsf

Public Methods

Method Description
EmailNotifier ( ) : System

Initializes a new instance of the EmailNotifier class.
LoadSettings ( ) : void

Loads saved EmailNotifier settings from the config file if the GSF.Adapters.Adapter.PersistSettings property is set to true.
SaveSettings ( ) : void

Saves EmailNotifier settings to the config file if the GSF.Adapters.Adapter.PersistSettings property is set to true.

Protected Methods

Method Description
NotifyAlarm ( string subject, string message, string details ) : void

Processes a NotificationTypes.Alarm notification.
NotifyHeartbeat ( string subject, string message, string details ) : void

Processes a NotificationTypes.Heartbeat notification.
NotifyInformation ( string subject, string message, string details ) : void

Processes a NotificationTypes.Information notification.
NotifyWarning ( string subject, string message, string details ) : void

Processes a NotificationTypes.Warning notification.

Private Methods

Method Description
SendEmail ( string subject, string message, string details ) : void

Method Details

EmailNotifier() public method

Initializes a new instance of the EmailNotifier class.
public EmailNotifier ( ) : System
return System

LoadSettings() public method

Loads saved EmailNotifier settings from the config file if the GSF.Adapters.Adapter.PersistSettings property is set to true.
public LoadSettings ( ) : void
return void

NotifyAlarm() protected method

Processes a NotificationTypes.Alarm notification.
protected NotifyAlarm ( string subject, string message, string details ) : void
subject string Subject matter for the notification.
message string Brief message for the notification.
details string Detailed message for the notification.
return void

NotifyHeartbeat() protected method

Processes a NotificationTypes.Heartbeat notification.
protected NotifyHeartbeat ( string subject, string message, string details ) : void
subject string Subject matter for the notification.
message string Brief message for the notification.
details string Detailed message for the notification.
return void

NotifyInformation() protected method

Processes a NotificationTypes.Information notification.
protected NotifyInformation ( string subject, string message, string details ) : void
subject string Subject matter for the notification.
message string Brief message for the notification.
details string Detailed message for the notification.
return void

NotifyWarning() protected method

Processes a NotificationTypes.Warning notification.
protected NotifyWarning ( string subject, string message, string details ) : void
subject string Subject matter for the notification.
message string Brief message for the notification.
details string Detailed message for the notification.
return void

SaveSettings() public method

Saves EmailNotifier settings to the config file if the GSF.Adapters.Adapter.PersistSettings property is set to true.
public SaveSettings ( ) : void
return void