Mailer Class Reference

Creates and sends an email message. More...

Inheritance diagram for Mailer:

List of all members.

Public Member Functions

addAttachment ($path, $name, $type="octet-stream")

Add an attachment to the email.

addRecipient ($recipient)

Add a recipient to the email.

clearRecipients ()

Clear the list of recipients.

sendMail ()

Send the email message.

setDevRecipient ($email)

Set the email address that emails will be sent to during testing.

setFrom ($from)

Set the from address.

setMessage ($message)

Set the message body of the email.

setReplyTo ($address)

Set the reply-to address.

setSubject ($subject)

Set the subject of the email.

Protected Member Functions

processRecipients ()

Join the recipient list into a comma-delimeted string.

Detailed Description

Creates and sends an email message.

Author:: Ismael (itorres@shodor.org)
Sandy (sbrady@shodor.org) adding attachment support

Definition at line 8 of file Mailer.php5.

Member Function Documentation

Mailer::addAttachment	(	$	path,
		$	name,
		$	type = `"octet-stream"`
	)

Add an attachment to the email.

Parameters:

	$path	[string]: The path to the file we are attaching
	$name	[string]: The name of the file.
	$type	[string]: (optional) The MIME type for the file. If none is set it will default to octet-stream.

Returns:: [boolean]: True on success, false on failure;

Definition at line 90 of file Mailer.php5.

Mailer::addRecipient ( $ recipient )

Add a recipient to the email.

Parameters:

$recipient

[mixed]: An email address of a recipient, or an array of email addresses

Definition at line 65 of file Mailer.php5.

Mailer::processRecipients ( ) [protected]

Join the recipient list into a comma-delimeted string.

For internal use only.

This function is used by sendMail() before the message is sent.

Definition at line 162 of file Mailer.php5.

Referenced by sendMail().

Mailer::sendMail ( )

Send the email message.

Sends a message containing the subject, message body, reply-to, etc., to all added recipients (call processRecipients() to generate a string version of the recipient list)

Definition at line 123 of file Mailer.php5.

References processRecipients().

Mailer::setDevRecipient ( $ email )

Set the email address that emails will be sent to during testing.

<<<<<<< Updated upstream

Parameters:

$email

[string]: The email that collects emails sent by the dev server during testing

Definition at line 23 of file Mailer.php5.

Mailer::setFrom ( $ from )

Set the from address.

Parameters:

$from

[string]: The email address from which the email will (appear to) be sent

Definition at line 57 of file Mailer.php5.

Mailer::setMessage ( $ message )

Set the message body of the email.

======= >>>>>>> Stashed changes

Parameters:

$message

[string]: The message body of the email

Definition at line 33 of file Mailer.php5.

Mailer::setReplyTo ( $ address )

Set the reply-to address.

Parameters:

$address

[string]: The reply-to email address for the email

Definition at line 49 of file Mailer.php5.

Mailer::setSubject ( $ subject )

Set the subject of the email.

Parameters:

$subject

[string]: The subject of the email

Definition at line 41 of file Mailer.php5.

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

content/Mailer.php5


Public Member Functions
	addAttachment ($path, $name, $type="octet-stream")
	Add an attachment to the email.
	addRecipient ($recipient)
	Add a recipient to the email.
	clearRecipients ()
	Clear the list of recipients.
	sendMail ()
	Send the email message.
	setDevRecipient ($email)
	Set the email address that emails will be sent to during testing.
	setFrom ($from)
	Set the from address.
	setMessage ($message)
	Set the message body of the email.
	setReplyTo ($address)
	Set the reply-to address.
	setSubject ($subject)
	Set the subject of the email.
Protected Member Functions
	processRecipients ()
	Join the recipient list into a comma-delimeted string.