C# Class Framework.Core.Utilities.Email.MailTemplate

Template email class.
Mostra file Open project: coreframework/Core-Framework Class Usage Examples

Private Properties

Property Type Description
GetFullTemplatePath String

Public Methods

Method Description
AddAttachment ( String path ) : void

Add attachment.

AppendParam ( String key, String value ) : void

Appends param with its value to the email.

AppendParam ( String key, String value, bool encode ) : void

Apends param to the email.

MailTemplate ( String bodyTemplate ) : System

Initializes a new instance of the MailTemplate class.

MailTemplate ( String templateDirectory, String bodyTemplate ) : System

Initializes a new instance of the MailTemplate class.

Send ( ) : bool

Send email.

Send ( String smtpHost, String user, String password ) : bool

Send email.

SendMails ( ) : bool

Sends mails to list of recipients specified in MailAddressCollection.

Protected Methods

Method Description
ReadTemplates ( String bodyTemplateFile ) : void

Initialize new instance of MailTemplate.

Private Methods

Method Description
GetFullTemplatePath ( String path ) : String

Gets the full template path.

Method Details

AddAttachment() public method

Add attachment.
public AddAttachment ( String path ) : void
path String Path to the file.
return void

AppendParam() public method

Appends param with its value to the email.
public AppendParam ( String key, String value ) : void
key String Param Key
value String Param value.
return void

AppendParam() public method

Apends param to the email.
public AppendParam ( String key, String value, bool encode ) : void
key String Param key.
value String Param value.
encode bool If true. the param value will be encided.
return void

MailTemplate() public method

Initializes a new instance of the MailTemplate class.
public MailTemplate ( String bodyTemplate ) : System
bodyTemplate String The body template.
return System

MailTemplate() public method

Initializes a new instance of the MailTemplate class.
public MailTemplate ( String templateDirectory, String bodyTemplate ) : System
templateDirectory String The template directory.
bodyTemplate String The body template.
return System

ReadTemplates() protected method

Initialize new instance of MailTemplate.
protected ReadTemplates ( String bodyTemplateFile ) : void
bodyTemplateFile String Name of the body template.
return void

Send() public method

Send email.
public Send ( ) : bool
return bool

Send() public method

Send email.
public Send ( String smtpHost, String user, String password ) : bool
smtpHost String The SMTP host.
user String The SMTP user.
password String The SMTP password.
return bool

SendMails() public method

Sends mails to list of recipients specified in MailAddressCollection.
public SendMails ( ) : bool
return bool