QuantConnect.Notifications.NotificationEmail Class Reference

Email notification data. More...

Inheritance diagram for QuantConnect.Notifications.NotificationEmail:

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...

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

Detailed Description

Email notification data.

Definition at line 108 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

address	Address to send to. Will throw ArgumentException if invalid Validate.EmailAddress
subject	Subject of the email. Will set to string.Empty if null
message	Message body of the email. Will set to string.Empty if null
data	Data to attach to the email. Will set to string.Empty if null
headers	Optional email headers to use

Definition at line 147 of file Notification.cs.

Here is the call graph for this function:

Property Documentation

Headers

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

getset

Optional email headers

Definition at line 114 of file Notification.cs.

Address

string QuantConnect.Notifications.NotificationEmail.Address

getset

Send to address:

Definition at line 119 of file Notification.cs.

Subject

string QuantConnect.Notifications.NotificationEmail.Subject

getset

Email subject

Definition at line 124 of file Notification.cs.

Message

string QuantConnect.Notifications.NotificationEmail.Message

getset

Message to send.

Definition at line 130 of file Notification.cs.

Data

string QuantConnect.Notifications.NotificationEmail.Data

getset

Email Data

Definition at line 136 of file Notification.cs.

---

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

• Common/Notifications/Notification.cs