Docs For Class Mail

object Mail &factory(
string
$driver, [array
$params = array()])

Provides an interface for generating Mail:: objects of various types

string	`$driver`	—	The kind of Mail:: object to instantiate.
array	`$params`	—	The parameters to pass to the Mail:: object.

[ Top ]

mixed send(
mixed
$recipients, array
$headers, string
$body)

Implements Mail::send() function using php's built-in mail() command.

Return: Returns true on success, or a PEAR_Error containing a descriptive error message on failure.
Deprecated: use Mail_mail::send instead
Access: public

Overridden in child classes as:

Mail_sendmail::send(): Implements Mail::send() function using the sendmail command-line binary.

Mail_null::send(): Implements Mail_null::send() function. Silently discards all mail.

Mail_mail::send(): Implements Mail_mail::send() function using php's built-in mail() command.

mixed	`$recipients`	—	Either a comma-seperated list of recipients (RFC822 compliant), or an array of recipients, each RFC822 valid. This may contain recipients not specified in the headers, for Bcc:, resending messages, etc.
array	`$headers`	—	The array of headers to send with the mail, in an associative array, where the array key is the header name (ie, 'Subject'), and the array value is the header value (ie, 'test'). The header produced from those values would be 'Subject: test'.
string	`$body`	—	The full text of the message body, including any Mime parts, etc.

[ Top ]

Class: Mail