RocksEmail Class

Description

This represents a email.

This handles adding attachments, cc and all other parts of emails.

property-read: array $to: an array of recipients that the email is being sent to
property-read: array $cc: the carbon copy addresses of the email
property-read: array $bcc: the blind carbon copy addresses of the email
property-read: array $attachments: the attachments of the email
property: string $subject: the subject of the email
property: string $from: the from address of the email
property: string $body: the body of the email
property: string $includeHtml: include a html version in the email
author: Dominic Skinner
version: 0.2.1

Located in /RocksEmail.php (line 21)

Method Summary

void AddAttachement (string $filename, [string $fileType = null], [string $data = null])

void AddBCC (string $address)

void AddCC (string $address)

void AddTemplatedBody (string $templateFilename)

void AddTo (string $address)

void Send ()

void __get ( $var)

void __set ( $var, $varValue)

void __toString ()

Methods

AddAttachement (line 122)

This adds a attachment to the email.

access: public

void AddAttachement (string $filename, [string $fileType = null], [string $data = null])

string $filename: the filename of the attachment
string $fileType: the file type of the attachment
string $data: of the attachment this is not needed as it can be retrieved from the filename.

AddBCC (line 69)

This adds a email address to the list of blind carbon copy email addresses

access: public

void AddBCC (string $address)

string $address: the email address to add

AddCC (line 60)

This adds a email address to the list of carbon copy email addresses

access: public

void AddCC (string $address)

string $address: the email address to add

AddTemplatedBody (line 81)

This adds a templated body to the email address which makes working with email much simpler.

All parameters after the $templatedFilename are then used in the template. There must be at least two parameters passed to this method.

access: public

void AddTemplatedBody (string $templateFilename)

string $templateFilename: the filename of the templated body

AddTo (line 51)

This adds a email address to the list of to email addresses

access: public

void AddTo (string $address)

string $address: the email address to add

Send (line 130)

This sends the email.

access: public

void Send ()

__get (line 42)

access: public

void __get ( $var)

$var

__set (line 33)

access: public

void __set ( $var, $varValue)

$var
$varValue

__toString (line 177)

access: public

void __toString ()

No comments have been provided.

Written by Dominic Skinner
Last Updated: 2009-09-22 17:51:45