User management for the world wide web

GenieGate_View_Mail Class Reference

A view for email. More...

Inheritance diagram for GenieGate_View_Mail:

[legend]Collaboration diagram for GenieGate_View_Mail:

[legend]List of all members.

Public Member Functions
	GenieGate_View_Mail ($to, $php)
	Constructor.
	subject ($subject=FALSE)
	get-set the subject.
	headers ($headers=FALSE)
	Set any additional headers.
	page ($php=FALSE)
	get-set the PHP page used for display.
	to ($to=FALSE)
	Get/Set the To: of the email.
	display ()
	Display sends output of $php to mail(), so mail is treated much like any other PHP document.
	param ($param=FALSE, $value=FALSE)
	Get/Set a named parameter.
	getLink ($qry=array())
	Returns a link to this page.

---

Detailed Description

A view for email.

This view is implemented using PHP's mail() function, it is designed as a view to make it "fit in" with the other View classes, and to provide a regular templating system for email.

PHP is rather known for having email problems, so all functionality that involves email should be centralized here to make it easy to "fix" PHP's mail() for a given host that lacks email support.

Definition at line 16 of file Mail.php.

---

Constructor & Destructor Documentation

GenieGate_View_Mail (  $  to, $  php )

Constructor. The $php parameter is used to create the body of the message. From within that PHP document, functions like subject() are available. Parameters: $to  - Who to send the email to. $php  - Page to send. Definition at line 32 of file Mail.php. References page(), and to().

---

Member Function Documentation

display (   )

Display sends output of $php to mail(), so mail is treated much like any other PHP document. Reimplemented from GenieGate_View. Definition at line 97 of file Mail.php. References subject().

getLink (  $  qry = array()  )  [inherited]

Returns a link to this page. Parameters: $qry  - An array of Key => Value pairs to be urlencoded. Returns: a string with a link to this page. Definition at line 66 of file View.php.

headers (  $  headers = FALSE  )

Set any additional headers. Definition at line 51 of file Mail.php.

page (  $  php = FALSE  )

get-set the PHP page used for display. (For reasons that are obvious, one should probably not set this within the old page) Definition at line 64 of file Mail.php. Referenced by GenieGate_View_Mail().

param (  $  param = FALSE, $  value = FALSE )  [inherited]

Get/Set a named parameter. With no parameters, returns an associative array of all the available parameters. (Same as $view->PARAM, but encapsulated) With 1 parameter, ($param) just returns the value of the named parameter. With 2 parameters, assigns $param a new value (returns old value). Parameters: $param  - The parameter name. $value  - The value to assign it to. Definition at line 36 of file View.php. Referenced by GenieGate_View_XMLExport::display().

subject (  $  subject = FALSE  )

get-set the subject. Definition at line 40 of file Mail.php. Referenced by display().

to (  $  to = FALSE  )

Get/Set the To: of the email. The to: has all [, ] removed to prevent email abuse. This may cause problems with email addresses that happen to contain ,'s (which are extremely unlikely anyway) Definition at line 79 of file Mail.php. Referenced by GenieGate_View_Mail().

---

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

• Mail.php

---

Documentation generated by DoxyGen