Docs For Class Mail2

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

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

Return: a instance of the driver class
Access: public

Parameters:

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

[ Top ]

array parseRecipients(
mixed
$recipients)

Take a set of recipients and parse them, returning an array of bare addresses (forward paths) that can be passed to sendmail or an smtp server with the rcpt to: command.

Return: An array of forward paths (bare addresses)
Access: protected

Parameters:

mixed $recipients — Either a comma-seperated list of recipients (RFC822 compliant), or an array of recipients, each RFC822 valid.

[ Top ]

mixed prepareHeaders(
array
$headers)

Take an array of mail headers and return a string containing text usable in sending a message.

Return: Returns false if it encounters a bad address, otherwise returns an array containing two elements: Any From: address found in the headers, and the plain text version of the headers.
Access: protected

Parameters:

array $headers — The array of headers to prepare, 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'.

[ 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
Deprecated: use Mail_mail::send instead
Access: public

Overridden in child classes as:

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

Mail2_mock::send(): Implements Mail_mock::send() function. Silently discards all mail.

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

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

Mail2_smtp::send(): Implements Mail::send() function using SMTP.

Mail2_smtpmx::send(): Implements Mail::send() function using SMTP direct delivery

Parameters:

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 ]

void _sanitizeHeaders(

&$headers, array
$headers)

Sanitize an array of mail headers by removing any additional header strings present in a legitimate header's value. The goal of this filter is to prevent mail injection attacks.

Access: protected

Parameters:

array	`$headers`	—	The associative array of headers to sanitize.
	`&$headers`	—

[ Top ]

Class: Mail2

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$sep = "\r\n"

Method Detail

factory [line 72]

Parameters:

parseRecipients [line 231]

Parameters:

prepareHeaders [line 171]

Parameters:

send [line 109]

Parameters:

_sanitizeHeaders [line 147]

Parameters: