Cts_Email

Summary
Cts_Email
AuthorJaybill McCarthy
Licensehttp://communit.as/docs/license
Constructors
Cts_EmailSets a template path variable (_template_path), and instantiates a logger.
sendEmailSends an email.
sendHtmlEmailSends an HTML email.

Author

Jaybill McCarthy

Constructors

Cts_Email

function Cts_Email($template_path =  null,
$module =  "default")

Sets a template path variable (_template_path), and instantiates a logger.

Arguments

template_pathAn optional string to override the default template path.

sendEmail

function sendEmail($subject,  
$to_address,  
$template,  
$params =  null,
$to_name =  null,
$isHtml =  false)

Sends an email.

Arguments

subjectThe subject line of the email to send.
to_addressThe recipient email address to send the email to.
templateA template file to use for the layout.
params (optional)An array of arbitrary parameters that get rendered as view variables, each of which can be used within the supplied template.
to_name (optional)The name of the recipient.
isHtml (optional)Sets whether the email is plain text (false) or HTML (true).  Default is false.

Returns: void

sendHtmlEmail

function sendHtmlEmail($subject,  
$to_address,  
$template,  
$params =  null,
$to_name =  null)

Sends an HTML email.  The same as using sendEmail with the isHtml boolean set to true (in fact, that’s all this does).

Arguments

subjectThe subject line of the email to send.
to_addressThe recipient email address to send the email to.
templateA template file to use for the layout. params (optional) - to_name (optional) -

See Also

function Cts_Email($template_path =  null,
$module =  "default")
Sets a template path variable (_template_path), and instantiates a logger.
function sendEmail($subject,  
$to_address,  
$template,  
$params =  null,
$to_name =  null,
$isHtml =  false)
Sends an email.
function sendHtmlEmail($subject,  
$to_address,  
$template,  
$params =  null,
$to_name =  null)
Sends an HTML email.
Close