Sphyrnidae.Common.EmailUtilities.EmailBase Class Reference

Base class for sending system emails More...

Public Member Functions
void	SetName (string first, string last)
Task< bool >	SendAsync ()
	Sends the email More...

Protected Member Functions
	EmailBase (IIdentityHelper identity, IEmail email)

Properties
IIdentityHelper	Identity [get]
IEmail	EmailImpl [get]
abstract string	Subject [get]
	Subject (and HTML title) of the email More...
abstract string	Content [get]
	Email-specific content More...
virtual string	Name [get, set]
	Name of the user (If not provided, will default to identity name) More...
virtual string	Email [get, set]
	E-mail address of the user (If not provided, will default to identity email address) More...
abstract bool	ValidatePropertiesSet [get]
	Child classes must be able to specify if all the required properties have been set or not More...
virtual string	Shell [get]

Detailed Description

Base class for sending system emails

To send a system email, inherit from this class and implement the abstract methods

Constructor & Destructor Documentation

EmailBase()

Sphyrnidae.Common.EmailUtilities.EmailBase.EmailBase ( IIdentityHelper  identity, IEmail  email  )

protected

Member Function Documentation

SendAsync()

Task<bool> Sphyrnidae.Common.EmailUtilities.EmailBase.SendAsync

(

)

Sends the email

If 'Name' or 'Email' properties are not set, this will use the logged in user

Returns

True if email seems to have sent ok, false otherwise

SetName()

void Sphyrnidae.Common.EmailUtilities.EmailBase.SetName	(	string	first,
		string	last
	)

Property Documentation

Content

abstract string Sphyrnidae.Common.EmailUtilities.EmailBase.Content

getprotected

Email-specific content

Email

virtual string Sphyrnidae.Common.EmailUtilities.EmailBase.Email

getset

E-mail address of the user (If not provided, will default to identity email address)

EmailImpl

IEmail Sphyrnidae.Common.EmailUtilities.EmailBase.EmailImpl

getprotected

Identity

IIdentityHelper Sphyrnidae.Common.EmailUtilities.EmailBase.Identity

getprotected

Name

virtual string Sphyrnidae.Common.EmailUtilities.EmailBase.Name

getsetprotected

Name of the user (If not provided, will default to identity name)

Shell

virtual string Sphyrnidae.Common.EmailUtilities.EmailBase.Shell

getprotected

Subject

abstract string Sphyrnidae.Common.EmailUtilities.EmailBase.Subject

getprotected

Subject (and HTML title) of the email

ValidatePropertiesSet

abstract bool Sphyrnidae.Common.EmailUtilities.EmailBase.ValidatePropertiesSet

getprotected

Child classes must be able to specify if all the required properties have been set or not

---

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

• C:/Users/dougb/Desktop/Sphyrnidae/New/Common/Common/EmailUtilities/EmailBase.cs