Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Mail Class Reference
[Helper Classes]

List of all members.

Detailed Description

Simple, unified mail interface.

Mail is a singleton class that handles sending mail in an easy, __autoload friendly fashion.

Definition at line 10 of file mail.inc.php.

Static Public Member Functions

 send ($to, $subject, $message, $html=null, $from=null)
 send our mail to an address
 setMailer (phpmailer $mailer)
 set our mailer object.
 getMailer ()
 get our mailer object.

Private Member Functions

 __construct ()
 no instantiation...

Static Private Attributes

 $mailer
 this is our mailer class instance.


Member Function Documentation

Mail::__construct  )  [private]
 

no instantiation...

singleton class

Definition at line 20 of file mail.inc.php.

Mail::getMailer  )  [static]
 

get our mailer object.

Returns:
our phpmailer derived object

Definition at line 55 of file mail.inc.php.

Mail::send to,
subject,
message,
html = null,
from = null
[static]
 

send our mail to an address

Parameters:
$to the to email address, or a comma separated list of them.
$subject the subject of the email
$message the body of the email
$html the html body of the email
$from the from email address
Returns:
the result of the email sending.

Definition at line 35 of file mail.inc.php.

Referenced by BaseUser::mail(), and EmailSMSProvider::send().

Mail::setMailer phpmailer $  mailer  )  [static]
 

set our mailer object.

Parameters:
$mailer a phpmailer derived object

Definition at line 45 of file mail.inc.php.


Member Data Documentation

Mail::$mailer [static, private]
 

this is our mailer class instance.

Definition at line 15 of file mail.inc.php.


The documentation for this class was generated from the following file:
Generated on Fri Oct 27 12:26:41 2006 for BaseJumper by doxygen 1.3.9.1