%SYS
Email Class Reference

Provides a simple way for the System Monitor to send alerts via email. More...

Inheritance diagram for Email:
Collaboration diagram for Email:

Public Member Functions

_.Library.Status OnNew (_.Library.RawString initval)
 Calls Initialize() to fetch email configuration (Server, Recipients, SSL Config). More...
 
_.Library.Status Initialize ()
 Initialize the email object using configured Server, Recipients, SSL Config, etc. More...
 
_.Library.Status SendEmail (_.Library.String msg)
 Sends message via configured email.
 

Public Attributes

 Mailer
 Mailer. More...
 
 Msg
 Mail message. More...
 

Detailed Description

Provides a simple way for the System Monitor to send alerts via email.

May be used by user extensions for Sensors, Subscribers or Notifiers to send configured email alerts by calling New() and SendEmail(). Note that New() can fail if the Server or Recipients are not correctly configured, so the caller should check for this and report the error in objlasterror.

Member Function Documentation

◆ OnNew()

Calls Initialize() to fetch email configuration (Server, Recipients, SSL Config).

If New() fails and

returns a null OREF, then the error will be in objlasterror.

◆ Initialize()

_.Library.Status Initialize ( )

Initialize the email object using configured Server, Recipients, SSL Config, etc.

May fail if missing configuration info, see Status.

Member Data Documentation

◆ Mailer

Mailer

Mailer.

 

◆ Msg

Msg

Mail message.