Lean  $LEAN_TAG$
QuantConnect.Notifications.NotificationEmail Class Reference

Email notification data. More...

Inheritance diagram for QuantConnect.Notifications.NotificationEmail:
[legend]

Public Member Functions

 NotificationEmail (string address, string subject="", string message="", string data="", Dictionary< string, string > headers=null)
 Default constructor for sending an email notification More...
 
- Public Member Functions inherited from QuantConnect.Notifications.Notification
virtual void Send ()
 Method for sending implementations of notification object types. More...
 

Public Attributes

Dictionary< string, string > Headers
 Optional email headers More...
 
string Address
 Send to address: More...
 
string Subject
 Email subject More...
 
string Message
 Message to send. More...
 
string Data
 Email Data More...
 

Detailed Description

Email notification data.

Definition at line 106 of file Notification.cs.

Constructor & Destructor Documentation

◆ NotificationEmail()

QuantConnect.Notifications.NotificationEmail.NotificationEmail ( string  address,
string  subject = "",
string  message = "",
string  data = "",
Dictionary< string, string >  headers = null 
)

Default constructor for sending an email notification

Parameters
addressAddress to send to. Will throw ArgumentException if invalid Validate.EmailAddress
subjectSubject of the email. Will set to string.Empty if null
messageMessage body of the email. Will set to string.Empty if null
dataData to attach to the email. Will set to string.Empty if null
headersOptional email headers to use

Definition at line 145 of file Notification.cs.

Here is the call graph for this function:

Member Data Documentation

◆ Headers

Dictionary<string, string> QuantConnect.Notifications.NotificationEmail.Headers

Optional email headers

Definition at line 112 of file Notification.cs.

◆ Address

string QuantConnect.Notifications.NotificationEmail.Address

Send to address:

Definition at line 117 of file Notification.cs.

◆ Subject

string QuantConnect.Notifications.NotificationEmail.Subject

Email subject

Definition at line 122 of file Notification.cs.

◆ Message

string QuantConnect.Notifications.NotificationEmail.Message

Message to send.

Definition at line 128 of file Notification.cs.

◆ Data

string QuantConnect.Notifications.NotificationEmail.Data

Email Data

Definition at line 134 of file Notification.cs.


The documentation for this class was generated from the following file: